API 제한 정의

API 도구는 API의 사용을 명시적으로 문서화하고 제한하기 위해 Javadoc 태그를 제공합니다. 다음은 각 태그의 시맨틱 및 각 멤버에 의해 지원되는 Javadoc 태그를 요약한 표입니다.

클라이언트는 연관된 API가 정의된 번들을 필요로 하는 번들 또는 플러그인을 참조합니다. 제한은 API가 정의된 것과 동일한 번들에서는 적용되지 않습니다. 예를 들어, 인터페이스를 @noimplement로 정의한 번들도 해당 인터페이스의 구현을 제공하기 위해 허용될 수 있습니다.

지원되는 제한 태그

  클래스 인터페이스 메소드 생성자

최종 필드

최종이 아닌 필드
@noimplement
-
지원됨
-
-
-
-
@noextend
지원됨
지원됨
-
-
-
-
@noinstantiate
지원됨
-
-
-
-
-
@nooverride
-
-
지원됨
-
-
-
@noreference
-
-
지원됨
지원됨
-
지원됨

제한 시맨틱

@noimplement

클라이언트가 이 인터페이스를 구현하지 않아야 함을 표시합니다. 구현 중인 수퍼클래스가 없는 연관된 인터페이스의 상위나 연관된 인터페이스의 implements 키워드를 사용하는 모든 클래스에 문제점이 플래그됩니다.

@noextend
클라이언트가 이 클래스나 인터페이스를 확장하지 않아야 함을 표시합니다. 연관된 유형에 대해 extends 키워드를 사용하는 모든 클래스나 인터페이스에 문제점이 플래그됩니다.
@noinstantiate
클라이언트가 이 인터페이스를 인스턴스화하지 않아야 함을 표시합니다. 임의의 생성자를 사용하여 연관된 클래스를 인스턴스화하는 모든 코드에 문제점이 플래그됩니다.
@nooverride
클라이언트가 이 메소드를 재선언하지 말아야 함을 표시합니다. 연관된 메소드를 대체하는 메소드를 정의하는 모든 서브클래스에 문제점이 플래그됩니다.
@noreference
클라이언트가 이 메소드, 생성자 또는 최종이 아닌 필드를 참조하지 않아야 함을 표시합니다. 연관된 메소드 또는 생성자를 직접 호출하거나 연관된 최종이 아닌 필드를 참조하는 모든 코드에 문제점이 플래그됩니다.

관련 태스크

기준선 설정

관련 참조

Javadoc @since 태그 관리
API 기준선 환경 설정
API 오류 및 경고 환경 설정