API 문서의 구성

이 API (Application Programming Interface) 문서에는, 다음에 설명하는 네비게이션 바에 있는 항목에 대응하는 페이지가 포함됩니다.

개요

개요 페이지는 API 문서의 신문 제１면으로, 각 패키지의 개요를 포함한 전패키지의 일람이 표시됩니다. 일련의 패키지의 개요 설명도 표시됩니다.

패키지

각 패키지는, 그 패키지의 클래스와 인터페이스에의 링크를 포함한 페이지를 가집니다. 이 페이지는 4 개의 카테고리로 구성됩니다:

• 인터페이스 (이탤릭)
• 클래스
• 열거형
• 예외
• 에러
• 주석형

클래스 또는 인터페이스

각 클래스, 인터페이스, 상자 클래스, 및 상자 인터페이스는 개별의 페이지를 가집니다. 각 페이지에는 다음과 같이, 클래스 또는 인터페이스의 설명과 개요 테이블, 및 멤버의 상세 설명이 포함됩니다:

• 클래스 계층 표시
• 직계의 서브 클래스
• 기존의 서브 인터페이스의 일람
• 기존의 구현 클래스의 일람
• 클래스 또는 인터페이스의 선언
• 클래스 또는 인터페이스의 기술

• 상자의 클래스의 개요
• 필드의 개요
• 생성자 의 개요
• 메소드의 개요

• 필드의 상세
• 생성자 의 상세
• 메소드의 상세

각 개요 엔트리에는, 그 항목의 상세한 기술중에서 1 행 째의 문장이 표시됩니다. 상세한 기술은 원시 코드에 나타나는 순으로 늘어놓을 수 있습니다만, 개요 엔트리는 알파벳순서에 늘어놓을 수 있습니다. 이것에 의해, 프로그래머가 설정한 논리적인 그룹 나누기가 보관 유지됩니다.

주석형

각 주석형에는, 그것 자신의 개별의 페이지와 다음의 섹션이 있습니다:

• 주석형의 선언
• 주석형의 설명
• 필수 요소의 개요
• 임의 요소의 개요
• 요소의 상세

열거형

각 열거형에는, 그것 자신의 개별의 페이지와 다음의 섹션이 있습니다:

• 열거형의 선언
• 열거형의 설명
• 열거형 정수의 개요
• 열거형 정수의 상세

사용

각 문서화 된 패키지, 클래스, 및 인터페이스는 각각 [사용] 페이지를 가지고 있습니다. 이 페이지에는, 어떠한 패키지, 클래스, 메소드, 생성자 , 및 필드가, 특정의 클래스 또는 패키지의 일부를 사용하고 있을지가 기술되고 있습니다. 예를 들어, 클래스 A 또는 인터페이스 A 의 경우, 그 [사용] 페이지에는, A 의 서브 클래스, A 로서 선언되는 필드, A 를 돌려주는 메소드, 및, 형태 A 를 가지는 메소드와 생성자 이 포함됩니다. 이 페이지에 액세스 하려면 , 우선 그 패키지, 클래스, 또는 인터페이스로 이동해, 네비게이션 바의 [사용] 링크를 클릭해 주세요.

계층 트리 (클래스 계층)

모든 패키지에는 클래스 계층 페이지가 있어, 한층 더 각 패키지의 계층이 있습니다. 각층층 페이지는, 클래스의 리스트와 인터페이스의 리스트를 포함합니다. 클래스는 java.lang.Object 를 개시점으로 하는 상속 구조로 편성됩니다. 인터페이스는,java.lang.Object 로부터는 상속하지 않습니다.

• 개요 페이지를 표시하고 있을 때 [트리] 를 클릭하면(자), 전패키지의 계층이 표시됩니다.
• 특정의 패키지, 클래스, 또는 인터페이스를 표시하고 있을 때 [트리] 를 클릭하면(자), 해당하는 패키지만의 계층이 표시됩니다.

추천되어 있지 않은 API

추천되어 있지 않은 API 페이지는, 추천되어 있지 않은 모든 API 의 리스트를 표시합니다. 비추천 API 란, 기능 개량등의 이유로부터 사용을 추천할 수 없게 된 API 로, 일반적으로은 거기에 대신하는 API 가 제공됩니다. 비추천 API 는 향후의 구현으로 삭제될 가능성이 있습니다.

색인

색인 에는, 모든 클래스, 인터페이스, 생성자 , 메소드, 및 필드의 알파벳순서의 리스트가 포함됩니다.

전/차

이러한 링크에 의해, 전 또는 다음의 클래스, 인터페이스, 패키지, 또는 관련 페이지로 이동할 수 있습니다.

프레임 있어/프레임 없음

이러한 링크는 HTML 프레임을 표시하거나 숨기거나 합니다. 모든 페이지는 프레임에서도, 프레임없이도 표시할 수 있습니다.

직렬화 된 형식

직렬화 가능, 또는 외부화 가능한 각 클래스는, 직렬화 필드와 메소드의 기술을 포함합니다. 이 정보는, API 를 사용하는 개발자는 아니고, 재구현을 실시하는 담당자에 도움이 됩니다. 네비게이션 바에 링크가 없는 경우, 직렬화 된 클래스로 이동해, 클래스 기술의 [관련 항목] 섹션에 있는 [직렬화 된 형식] 을 클릭하는 것으로써, 이 정보를 표시할 수 있습니다.

정수 필드치

「정수 필드치」 페이지에는, static final 필드와 그 값의 리스트가 있습니다.

이 헬프 파일은, 표준 doclet 를 사용해 생성된 API 문서에 적용됩니다.