API 오류 및 경고 환경 설정

다음 환경 설정은 콘솔 환경 설정 페이지 열기 플러그인 개발 > API 오류/경고 환경 설정 페이지를 사용하여 설정할 수 있습니다.

API 문제점은 프로젝트 빌드 시(자동 및 전체 빌드) 생성됩니다. 도구를 사용하여 다음 세 가지 카테고리 중 하나로 보고된 문제점의 유형을 분석합니다.

  1. 사용 문제점 - 권한 없는 플러그인에서 제한된 코드를 호출합니다.
  2. API 비호환성 - 버전 간 변경사항에 호환성이 없습니다.
  3. 버전 문제점 - 플러그인 버전 또는 코드 버전(@since 태그)이 올바르지 않습니다.
  4. 분석 옵션 - 일반 옵션

프로젝트의 API 오류/경고 특성 페이지를 사용하여 프로젝트마다 문제점 심각도를 구성할 수도 있습니다.

API 사용

API 사용 옵션 환경 설정 페이지

일반

옵션

설명

기본값

지원되지 않는 API Javadoc 태그 사용

사용할 경우, API 분석 빌더는 잘못 사용된 API Javadoc 태그를 확인합니다.

무시

지정된 실행 환경에 정의되지 않은 참조

API 분석 빌더를 사용하면 번들에 대해 지정된 실행 환경에 따라 잘못된 것일 수 있는 시스템 라이브러리에 대한 참조를 확인합니다.

무시

제한사항

옵션

설명

기본값

'@noimplement'로 표시된 인터페이스 구현

사용할 경우, API 분석 빌더는 표시된 인터페이스의 잘못된 구현을 확인합니다.

경고

'@noextend'로 표시된 유형 확장

사용할 경우, API 분석 빌더는 표시된 유형을 확장하는 클래스를 확인합니다.

경고

'@noreference'로 표시된 필드 또는 메소드 참조

사용할 경우, API 분석 빌더는 태그가 지정된 멤버에 대한 필드 및 메소드 참조를 확인합니다.

경고

'@noinstantiate' 태그가 지정된 클래스 인스턴스화

사용할 경우, API 분석 빌더는 태그가 지정된 클래스가 인스턴스화되지 않았는지 확인합니다.

경고

'@nooverride'로 표시된 메소드 대체

사용할 경우, API 분석 빌더는 확장하거나(대체된 상위를 호출하여 재구현함) 재구현하여(대체된 상위를 호출하지 않음) 상위 클래스에서 태그가 지정된 메소드가 하위 클래스에서 대체되지 않았는지 확인합니다.

경고

누수

옵션

설명

기본값

비API 클래스 확장

사용할 경우, API 분석 빌더는 API 클래스가 비API 유형을 확장하는지 확인합니다.

경고

비API 인터페이스 구현

사용할 경우, API 분석 빌더는 API 클래스가 비API 인터페이스를 구현하는지 확인합니다.

경고

비API 유형의 필드

사용할 경우, API 분석 빌더는 API 유형에 비API 유형의 공용 또는 보호 필드가 있는지 확인합니다.

경고

비API 리턴 유형의 메소드

사용할 경우, API 분석 빌더는 API 유형에 비API 리턴 유형의 public 또는 protected 메소드가 있는지 확인합니다.

경고

비API 매개변수 유형의 메소드

사용할 경우, API 분석 빌더는 API 유형에 비API 매개변수 유형의 public 또는 protected 메소드가 있는지 확인합니다.

경고

API 호환성

API 호환성 옵션 환경 설정 페이지

옵션

설명

기본값

주 버전 향상으로 권한 부여된 경우에도 API 파손 보고

사용할 경우, 번들의 주 버전이 이미 향상된 경우에도 API 분석 빌더는 API 파손의 문제점을 보고합니다.

사용 안함

번들

옵션

설명

기본값

API 유형이 비API가 됨

사용할 경우, API 분석 빌더는 현재 번들의 API 유형이 비API 유형으로 변경되었는지 확인합니다.

오류

유형이 제거됨

사용할 경우, API 분석 빌더는 지정된 번들의 API 범위에서 API 유형이 제거되었는지 확인합니다.

오류

다시 내보낸 API 유형이 비API가 됨

사용할 경우, API 분석 빌더는 현재 번들의 다시 내보낸 API 유형이 비API 유형으로 변경되었는지 확인합니다.

오류

다시 내보낸 유형이 제거됨

사용할 경우, API 분석 빌더는 지정된 번들의 API 범위에서 다시 내보낸 API 유형이 제거되었는지 확인합니다.

오류

클래스

옵션

설명

기본값

메소드(구현될 필요가 있음)가 추가되었음

사용할 경우, API 분석 빌더는 구현해야 하는 public 또는 protected 메소드가 API 유형에 추가되었는지 확인합니다.

오류

제한사항이 추가됨

사용할 경우, API 분석 빌더는 API 클래스의 API 제한사항이 추가되었는지 확인합니다.

오류

유형 매개변수가 추가됨

사용할 경우, API 분석 빌더는 API 클래스에 유형 매개변수가 추가되었는지 확인합니다.

오류

수퍼인터페이스 계층 구조가 축소됨

사용할 경우, API 분석 빌더는 API 클래스에서 상위 인터페이스가 제거되었는지 확인합니다.

오류

'abstract' 키워드가 추가됨

사용할 경우, API 분석 빌더는 API 클래스에 'abstract' 키워드가 추가되었는지 확인합니다.

오류

'final' 키워드가 추가됨

사용할 경우, API 분석 빌더는 API 클래스에 'final' 키워드가 추가되었는지 확인합니다.

오류

어노테이션, 열거 또는 인터페이스로 변환됨

사용할 경우, API 분석 빌더는 API 클래스가 어노테이션, 열거 또는 인터페이스로 변경되었는지 확인합니다.

오류

가시성이 축소됨

사용할 경우, API 분석 빌더는 공용 API 클래스가 개인용 또는 기본 범위가 되었는지 확인합니다.

오류

필드가 제거됨

사용할 경우, API 분석 빌더는 API 클래스에서 공용 또는 보호 필드가 제거되었는지 확인합니다.

오류

메소드가 제거됨

사용할 경우, API 분석 빌더는 API 클래스에서 public 또는 protected 메소드가 제거되었는지 확인합니다.

오류

생성자가 제거됨

사용할 경우, API 분석 빌더는 API 클래스에서 공용 또는 보호 생성자가 제거되었는지 확인합니다.

오류

수퍼클래스 계층 구조가 축소됨

사용할 경우, API 분석 빌더는 계층 구조에서 수퍼클래스가 제거되었는지 확인합니다.

오류

멤버 유형이 제거됨

사용할 경우, API 분석 빌더는 API 클래스에서 멤버 유형이 제거되었는지 확인합니다.

오류

유형 매개변수가 제거됨

사용할 경우, API 분석 빌더는 API 클래스에서 유형 매개변수가 제거되었는지 확인합니다.

오류

인터페이스

옵션

설명

기본값

필드('@noimplement' 태그가 지정되지 않은 인터페이스)가 추가됨

사용할 경우, API 분석 빌더는 API 인터페이스에 공용 필드가 추가되었는지 확인합니다.

오류

메소드('@noimplement' 태그가 지정되지 않은 인터페이스)가 추가됨

사용할 경우, API 분석 빌더는 API 인터페이스에 공용 메소드가 추가되었는지 확인합니다.

오류

제한사항이 추가됨

사용할 경우, API 분석 빌더는 API 인터페이스의 API 제한사항이 추가되었는지 확인합니다.

오류

유형 매개변수가 추가됨

사용할 경우, API 분석 빌더는 API 인터페이스에 유형 매개변수가 추가되었는지 확인합니다.

오류

클래스, 열거 또는 어노테이션으로 변환됨

사용할 경우, API 분석 빌더는 API 인터페이스가 클래스, 열거 또는 인터페이스로 변경되었는지 확인합니다.

오류

수퍼인터페이스 계층 구조가 축소됨

사용할 경우, API 분석 빌더는 API 인터페이스의 상위 인터페이스가 제거되었는지 확인합니다.

오류

유형 매개변수가 제거됨

사용할 경우, API 분석 빌더는 API 인터페이스에서 유형 매개변수가 제거되었는지 확인합니다.

오류

필드가 제거됨

사용할 경우, API 분석 빌더는 API 인터페이스에서 공용 필드가 제거되었는지 확인합니다.

오류

메소드가 제거됨

사용할 경우, API 분석 빌더는 API 인터페이스에서 공용 메소드가 제거되었는지 확인합니다.

오류

멤버 유형이 제거됨

사용할 경우, API 분석 빌더는 API 인터페이스에서 멤버 유형이 제거되었는지 확인합니다.

오류

열거

옵션

설명

기본값

수퍼인터페이스 계층 구조가 축소됨

사용할 경우, API 분석 빌더는 API 열거에서 상위 인터페이스가 제거되었는지 확인합니다.

오류

어노테이션, 클래스 또는 인터페이스로 변환됨

사용할 경우, API 분석 빌더는 API 열거가 어노테이션, 클래스 또는 인터페이스로 변경되었는지 확인합니다.

오류

필드가 제거됨

사용할 경우, API 분석 빌더는 API 열거에서 공용 필드가 제거되었는지 확인합니다.

오류

열거 상수가 제거됨

사용할 경우, API 분석 빌더는 API 열거에서 열거 상수가 제거되었는지 확인합니다.

오류

메소드가 제거됨

사용할 경우, API 분석 빌더는 API 열거에서 공용 메소드가 제거되었는지 확인합니다.

오류

멤버 유형이 제거됨

사용할 경우, API 분석 빌더는 API 열거에서 멤버 유형이 제거되었는지 확인합니다.

오류

어노테이션

옵션

설명

기본값

기본값이 없는 메소드가 추가됨

사용할 경우, API 분석 빌더는 API 어노테이션에 기본값이 없는 메소드가 추가되었는지 확인합니다.

오류

클래스, 열거 또는 인터페이스로 변환됨

사용할 경우, API 분석 빌더는 API 어노테이션이 클래스, 열거 또는 인터페이스로 변환되었는지 확인합니다.

오류

필드가 제거됨

사용할 경우, API 분석 빌더는 API 어노테이션에서 공용 필드가 제거되었는지 확인합니다.

오류

메소드가 제거됨

사용할 경우, API 분석 빌더는 API 어노테이션에서 공용 메소드가 제거되었는지 확인합니다.

오류

멤버 유형이 제거됨

사용할 경우, API 분석 빌더는 API 어노테이션에서 Public 멤버 유형이 제거되었는지 확인합니다.

오류

필드

옵션

설명

기본값

상수 값이 추가됨

사용할 경우, API 분석 빌더는 API 유형에 대한 이전에 초기화되지 않은 공용 또는 보호 필드 상수에 상수 값이 추가되었는지 확인합니다.

오류

유형이 수정됨

사용할 경우, API 분석 빌더는 API 유형에 대한 공용 또는 보호 필드 유형이 변경되었는지 확인합니다.

오류

상수 값이 수정됨

사용할 경우, API 분석 빌더는 API 유형에서 공용 또는 보호 필드 상수의 값이 변경되었는지 확인합니다.

오류

가시성이 축소됨

사용할 경우, API 분석 빌더는 API 유형에서 공용 또는 보호 필드가 개인용이 되었는지 확인합니다.

오류

정적 상수의 'final' 키워드가 제거됨

사용할 경우, API 분석 빌더는 공용 또는 보호 필드가 API 유형에서 final 키워드를 제거했는지 확인합니다.

오류

'final' 키워드가 추가됨

사용할 경우, API 분석 빌더는 API 유형의 공용 또는 보호 필드에 final 키워드가 추가되었는지 확인합니다.

오류

'static' 키워드가 제거됨

사용할 경우, API 분석 빌더는 API 유형의 공용 또는 보호 필드에서 static 키워드가 제거되었는지 확인합니다.

오류

'static' 키워드가 추가됨

사용할 경우, API 분석 빌더는 API 유형의 공용 또는 보호 필드에 static 키워드가 추가되었는지 확인합니다.

오류

상수 값이 제거됨

사용할 경우, API 분석 빌더는 API 유형의 공용 또는 보호 필드 상수에 대한 상수 필드 값이 제거되었는지 확인합니다.

오류

유형 인수가 제거됨

사용할 경우, API 유형의 공용 또는 보호 필드에서 유형 인수가 제거되었는지 확인합니다.

오류

메소드

옵션

설명

기본값

@nooverride 제한사항이 추가됨

사용할 경우, API 분석 빌더는 @nooverride 태그를 추가하여 API 유형에서 public 또는 protected 메소드의 제한사항이 변경되었는지 확인합니다.

오류

유형 매개변수가 추가됨

사용할 경우, API 분석 빌더는 API 유형의 public 또는 protected 메소드에 유형 매개변수가 추가되었는지 확인합니다.

오류

가변 인수가 배열 유형으로 변환됨

사용할 경우, API 분석 빌더는 API 유형의 public 또는 protected 메소드에 대해 varargs 인수가 오브젝트 배열로 확장되었는지 확인합니다.

오류

가시성이 축소됨

사용할 경우, API 분석 빌더는 API 유형에 대해 public 또는 protected 메소드가 개인용이 되었는지 확인합니다.

오류

'abstract' 키워드가 추가됨

사용할 경우, API 분석 빌더는 API 유형에서 공용 또는 보호 필드가 abstract가 되었는지 확인합니다.

오류

'static' 키워드가 추가됨

사용할 경우, API 분석 빌더는 API 유형에서 public 또는 protected 메소드가 static이 되었는지 확인합니다.

오류

'static' 키워드가 제거됨

사용할 경우, API 분석 빌더는 API 유형에서 public 또는 protected 메소드가 비static이 되었는지 확인합니다.

오류

'final' 키워드가 추가됨('@noextend' 태그가 지정된 유형)

사용할 경우, API 분석 빌더는 @noextend 태그가 지정된 API 유형에서 public 또는 protected 메소드가 final이 되었는지 확인합니다.

오류

어노테이션 기본값이 제거됨

사용할 경우, API 분석 빌더는 API 어노테이션 메소드와 연관된 기본값이 제거되었는지 확인합니다.

오류

유형 매개변수가 제거됨

사용할 경우, API 유형의 public 또는 protected 메소드에서 유형 매개변수가 제거되었는지 확인합니다.

오류

생성자

옵션

설명

기본값

유형 매개변수가 추가됨

사용할 경우, API 분석 빌더는 API 유형의 공용 생성자에 유형 매개변수가 추가되었는지 확인합니다.

오류

가변 인수가 배열 유형으로 변환됨

사용할 경우, API 분석 빌더는 varargs 매개변수가 API 유형의 공용 생성자에 대한 오브젝트 배열로 확장되었는지 확인합니다.

오류

가시성이 축소됨

사용할 경우, API 분석 빌더는 API 유형에서 공용 생성자가 비공용이 되었는지 확인합니다.

오류

유형 매개변수가 제거됨

사용할 경우, API 분석 빌더는 API 유형의 공용 생성자에서 유형 매개변수가 제거되었는지 확인합니다.

오류

유형 매개변수

옵션

설명

기본값

클래스 바운드가 추가됨

사용할 경우, API 분석 빌더는 API 유형의 유형 매개변수에 클래스 바운드가 추가되었는지 확인합니다.

오류

인터페이스 바운드가 추가됨

사용할 경우, API 분석 빌더는 API 유형의 유형 매개변수에 인터페이스 바운드가 추가되었는지 확인합니다.

오류

클래스 바운드가 수정됨

사용할 경우, API 분석 빌더는 API 유형의 유형 매개변수에 클래스 바운드가 변경되었는지 확인합니다.

오류

인터페이스 바운드가 수정됨

사용할 경우, API 분석 빌더는 API 유형의 유형 매개변수에 인터페이스 바운드가 변경되었는지 확인합니다.

오류

클래스 바운드가 제거됨

사용할 경우, API 분석 빌더는 API 유형의 유형 매개변수에서 클래스 바운드가 제거되었는지 확인합니다.

오류

인터페이스 바운드가 제거됨

사용할 경우, API 분석 빌더는 API 유형의 유형 매개변수에서 인터페이스 바운드가 제거되었는지 확인합니다.

오류

버전 관리

API 버전 관리 옵션 환경 설정 페이지

옵션

설명

기본값

'@since' 태그가 누락된 보고서

사용할 경우, API 분석 빌더는 사용 중인 API 기준선 버전 이후로 추가된 유형 또는 멤버에 대해 @since 태그가 누락되었는지 확인합니다.

오류

잘못 구성된 '@since' 태그 보고

사용할 경우, API 분석 빌더는 현재 사용 중인 @since 태그가 잘못 구성되었는지(구문이 잘못됨) 확인합니다.

오류

올바르지 않은 '@since' 태그 버전 보고

사용할 경우, API 분석 빌더는 현재 사용 중인 @since 태그의 버전이 잘못되었는지 확인합니다.

오류

호환되지 않는 번들 버전 보고

사용할 경우, API 분석 빌더는 사용 중인 API 변경사항 및 현재 API 기준선에 따라 플러그인의 번들 버전이 올바르지 않은지 확인합니다.

오류

API 변경이 없는 사소한 버전 증가 무시

호환되지 않는 버전 번호에 대한 보고를 사용하는 경우 이 옵션을 사용하면 현재 API 기준선과 비교하여 API 변경이 없을 때 사소한 버전 변경을 무시하도록 API 분석 빌더에 지시할 수 있습니다.

On

API 변경이 없는 주요 버전 증가 무시

호환되지 않는 버전 번호에 대한 보고를 사용하는 경우 이 옵션을 사용하면 현재 API 기준선과 비교하여 API 변경이 없을 때 주요 버전 변경을 무시하도록 API 분석 빌더에 지시할 수 있습니다.

On

분석 옵션

분석 옵션 환경 설정 페이지

옵션

설명

기본값

필수 제한조건/전제조건 누락 번들

사용할 경우, API 분석 빌더는 전체 분석을 수행하지 못하게 하는 제한조건이나 전제조건 누락을 보고합니다. 이 옵션 값과 관계 없이 해당 번들에 대한 분석을 건너뜁니다.

오류

사용하지 않은 API 문제점 필터

사용할 경우, API 분석 빌더는 더 이상 사용되지 않는 API 문제점 필터를 보고합니다.

경고

API 사용 스캔 옵션

API 사용 스캔 옵션 환경 설정 페이지

옵션

설명

기본값

분석되지 않은 유형 문제점

사용할 경우, API 분석 빌더는 API 사용 스캔 환경 설정 페이지에 나열된 모든 사용 스캔에 포함되어 있는 제거된 API 유형을 보고합니다.

오류

분석되지 않은 메소드 문제점

사용할 경우, methods 분석 빌더는 API 사용 스캔 환경 설정 페이지에 나열된 모든 사용 스캔에 포함되어 있는 제거된 메소드를 보고합니다.

오류

분석되지 않은 필드 문제점

사용할 경우, fields 분석 빌더는 API 사용 스캔 환경 설정 페이지에 나열된 모든 사용 스캔에 포함되어 있는 제거된 필드를 보고합니다.

오류


관련 참조

PDE 환경 설정
API 오류 및 경고 특성 페이지
API 기준선 환경 설정
API 사용 스캔 환경 설정