API 비지원 Ant 태스크

목적

이 태스크는 기준선과 관련된 API 프로파일의 완전한 API 분석을 실행하여 더 이상 사용되지 않거나 사용되는 멤버(클래스, 필드, 메소드)만 찾습니다. 프로파일은 개발 중인 제품의 현재 상태입니다. 프로파일은 비지원 변경(보통 제품의 이전 릴리스)을 위해 API 기준선과 비교됩니다.

사용법

설명

Ant 태스크의 이름은 apitooling.apideprecation입니다. 사용하려면 jar 파일 apitooling-ant.jar가 Ant 클래스 경로에 있어야 합니다.

<apitooling.apideprecation
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	debug="..."
		eefile="..."
/>

매개변수

속성 설명 필수
기준선 이 속성은 참조 기준선의 위치를 지정합니다.

.zip, .jar, .tgz, .tar.gz 파일이거나, Eclipse 설치 폴더에 해당하는 디렉토리일 수 있습니다. 이것은 Eclipse 실행 파일을 찾을 수 있는 디렉토리입니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
프로파일 이 속성은 참조 기준선에 대해 비교하려는 현재 제품이나 프로파일의 위치를 지정합니다.

.zip, .jar, .tgz, .tar.gz 파일이거나, Eclipse 설치 폴더에 해당하는 디렉토리일 수 있습니다. 이것은 Eclipse 실행 파일을 찾을 수 있는 디렉토리입니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
보고서 보고서가 생성될 출력 위치를 설정합니다.

태스크가 완료되면, 필터 루트와 유사한 구조를 사용하는 이 디렉토리에서 보고서가 사용 가능합니다. 보고되는 문제점이 있는 각 컴포넌트마다 서브폴더가 작성됩니다. 각 서브폴더는 "report.xml"이라는 파일을 포함합니다.

"allNonApiBundles"이라는 특수 폴더도 "report.xml"이라는 파일도 포함하는 이 폴더에 작성됩니다. 이 파일은 API 도구 네이처를 사용하지 않는 모든 번들을 나열합니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
excludelist 제외 목록 위치를 설정합니다.

제외 목록 위치는 분석에서 제외할 번들을 나열하는 텍스트 파일을 지정합니다. 기본적으로, 프로파일의 모든 번들이 분석됩니다. 포함 및 제외 목록 속성을 사용하여 번들을 선택적으로 포함 및 제외할 수 있습니다. 또한 이 태스크는 포함 및 제외 목록의 멤버 나열을 지원합니다. 포함 목록은 번들 및 멤버의 세트가 분석되도록 하고(생략 시 모든 번들과 멤버가 포함됨), 그런 다음 제외 목록이 적용됩니다. 파일의 각 행은 다음 중 하나를 지정합니다.
  • 특정 번들 이름
  • 특정 멤버 이름
  • 번들 또는 멤버 이름에 대해 일치 여부를 확인하는 정규식("R:"로 시작하는 행)
  • 주석('#'으로 시작하는 행)

절대 경로를 사용하여 위치가 지정됩니다.
다음은 제외 목록 예제입니다.
 # ECLIPSE MEMBERS
 org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
제외 목록은 행이 "R:"로 시작하는 경우 정규식을 포함할 수 있습니다.
아니오
includelist 포함 목록 위치를 설정합니다.

포함 목록 위치는 분석에 포함할 번들을 나열하는 텍스트 파일을 지정합니다. 기본적으로, 프로파일의 모든 번들이 분석됩니다. 포함 및 제외 목록 속성을 사용하여 번들을 선택적으로 포함 및 제외할 수 있습니다. 또한 이 태스크는 포함 및 제외 목록의 멤버 나열을 지원합니다. 포함 목록은 번들 및 멤버의 세트가 분석되도록 하고(생략 시 모든 번들과 멤버가 포함됨), 그런 다음 제외 목록이 적용됩니다. 파일의 각 행은 다음 중 하나를 지정합니다.
  • 특정 번들 이름
  • 특정 멤버 이름
  • 번들 또는 멤버 이름에 대해 일치 여부를 확인하는 정규식("R:"로 시작하는 행)
  • 주석('#'으로 시작하는 행)

절대 경로를 사용하여 위치가 지정됩니다.
다음은 포함 목록 예제입니다.
 # ECLIPSE MEMBERS
 org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object;
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 ...
아니오
디버그 디버그 값을 설정합니다.

가능한 값: true, false
기본값은 false입니다.
아니오
eefile 사용할 실행 환경 파일을 설정합니다.

기본값으로, JavaSE-1.6 실행 환경에 해당하는 실행 환경 파일이 사용됩니다.

파일의 형식은 이 wiki 페이지에서 설명됩니다.

절대 경로를 사용하여 파일이 지정됩니다.
아니오

예제

 <apitooling.apideprecation
  baseline="D:\eclipse\3.4.1\eclipse"
  profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"

  report="D:\reports\xml"
  excludelist="D:\exclude_list_external.txt"
  debug="true"
 />

이것은 D:\reports\xml 폴더 내에서 report.xml 파일을 작성하는 태스크를 실행합니다. 제외 목록을 사용하여 보고할 문제점 수를 줄입니다.

디버그가 사용 가능하므로, 일부 디버그 추적이 Ant 콘솔에 표시됩니다.

관련 참조

API 정지 Ant 태스크
파일 생성 Ant 태스크
API 사용 Ant 태스크
분석 보고서 변환 Ant 태스크
API 정지 보고서 변환 Ant 태스크
API 사용 보고서 변환 Ant 태스크
API 비지원 보고서 변환 Ant 태스크