API 사용 Ant 태스크

목적

이 태스크는 API 사용의 보고서를 작성하기 위해 제공된 기준선의 전체 검색을 실행합니다.

API 도구가 사용되지 않은 번들은 분석에 포함하지 않습니다.

사용법

설명

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

<apitooling.apiuse
	location="..."
	scopepattern="..."
	referencepattern="..."
	report="..."
	considerinternal="..."
	considerapi="..."
	considerillegaluse="..."
	apipatterns="..."
	internalpatterns="..."
	archivepatterns="..."
	excludelist="..."
	includelist="..."	
			debug="..."
/>

매개변수

속성 설명 필수
location 이 속성은 API 사용을 검색하려는 현재 제품의 위치를 지정합니다.

.zip, .jar, .tgz, .tar.gz 파일이거나, 번들의 콜렉션 또는 제품을 포함하는 디렉토리일 수 있습니다.

절대 경로를 사용하여 위치가 지정됩니다.
예
scopepattern 이 속성은 위치를 검색할 번들을 선택하는 데 사용되는 정규식 패턴을 지정합니다.

예를 들어 다음은 Eclipse 번들의 API 사용만 스캔합니다.
org.eclipse.*
패턴은 여기에 정의된 대로 잘 형식화된 정규식이어야 합니다.
아니오
referencepattern 이 속성은 검색 결과를 필터링하는 데 사용되는 정규식 패턴을 지정합니다. 필터와 일치하는 번들을 참조하는 API 사용만 보고됩니다.

예를 들어 다음은 JDT의 코드를 참조하는 사용만 보고합니다.
org.eclipse.jdt.*
패턴은 여기에 정의된 대로 잘 형식화된 정규식이어야 합니다.
아니오
보고서 보고서가 생성될 출력 위치를 설정합니다.

태스크가 완료되면, 계층 구조를 사용하는 이 디렉토리에서 보고서가 사용 가능합니다. 참조하는 다른 번들이 있는 각 컴포넌트마다 서브폴더가 작성됩니다. 각 서브폴더는 "[bundlename].xml"이라는 파일을 포함합니다. 이 폴더 내에는 폴더를 포함하는 번들을 참조하는 각 번들마다 다른 서브폴더("[referencing bundle name].xml")가 있습니다. 참조 번들 폴더 내에는 해당 유형의 유형, 메소드 또는 필드 참조를 포함하는 세 개의 서브 폴더(API, PRIVATE 또는 OTHER) 중 하나가 있습니다

다른 세 개의 특수 파일 "counts.xml", "not_searched.xml" 및 "no_apidescription.xml"은 보고서 디렉토리로 작성되며 찾은 참조 수, 사용 정보가 검색되지 않는 기준선의 번들과 .api_description 파일이 없는 번들에 대한 정보를 각각 포함합니다.

절대 경로를 사용하여 위치가 지정됩니다.

예제:
  root
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- "counts.xml"
   +-- bundle name with usage
   		|
   		+--referencing bundle name
   			|
   			+-- [API or PRIVATE or OTHER]
   				|
   				+--[type_ or method_ or field_]references.xml
예
considerinternal 검색 동안 내부 참조가 고려되어야 하는 경우.

기본값은 false입니다.
아니오
considerapi 검색 동안 API 참조가 고려되어야 하는 경우.

기본값은 false입니다.
아니오
considerillegaluse 검색 동안 잘못된 API 사용 참조가 고려되어야 하는 경우

기본값은 false입니다.
아니오
apipatterns API 패키지로 고려되는 패키지 이름 패턴(정규식)의 쉼표 분리 목록입니다.

기본적으로 API 설명은 스캔한 번들에 사용되지만 API 패키지를 대체하거나 추가하는 데 이를 사용할 수 있습니다.
아니오
internalpatterns 개인용 패키지로 고려되는 패키지 이름 패턴(정규식)의 쉼표 분리 목록입니다.

기본적으로 API 설명은 스캔한 번들에 사용되지만 개인용 패키지를 대체하거나 추가하는 데 이를 사용할 수 있습니다.
아니오
archivepatterns 스캔 중 무시할 아카이브 ID의 쉼표 분리 목록입니다.

아카이브 ID의 양식은 다음과 같습니다. [bundle id]:[path to archive]
아니오
excludelist 제외 목록 위치를 설정합니다.

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

절대 경로를 사용하여 위치가 지정됩니다.
다음은 제외 목록 예제입니다.
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
아니오
includelist 포함 목록 위치를 설정합니다.

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

절대 경로를 사용하여 위치가 지정됩니다.
다음은 포함 목록 예제입니다.
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
아니오
필터 사용 스캔 중에 사용할 API 필터의 루트 디렉토리를 설정합니다.

인수는 참조를 필터링하는 데 사용해야 하는 .api_filters 파일의 루트 디렉토리입니다.

.api_filters 파일은 api 분석 중에 무시할 특정 문제점을 지정합니다. 사용 스캔 동안, 문제점 필터가 사용 스캔 결과에서 필터링될 참조의 목록으로 변환됩니다.

절대 경로를 사용하여 루트가 지정됩니다.
다음 구조를 포함하려면 루트가 필요합니다.
 root
  |
  +-- component name (i.e. org.eclipse.jface)
         |
         +--- .api_filters
아니오
디버그 디버그 값을 설정합니다.

가능한 값: true, false
기본값은 false입니다.
아니오

예제

	<apitooling.apiuse
		location="/eclipse/eclipse.tar.gz"
		scopepattern=".*"
		referencepattern="org\.eclipse.*"
		report="/eclipse/apiuse-both/XML"
		considerinternal="true"
		considerapi="true"
		considerillegaluse="true"
		archivepatterns="org.eclipse.test.bundle:/libs/contributed.jar"
		excludelist="D:\exclude_list_external.txt"
		debug="true"
	/>

이것은 /eclipse/apiuse-both/XML 폴더 내에서 *.xml 파일을 작성하는 태스크를 실행합니다. 해당 태스크로 해당 ID가 org\.eclipse.* 정규식에서 정의한 org.eclipse로 시작되는 번들에 대한 모든 참조를 검색하여 정규식 .*에서 정의한 제품 위치의 모든 번들을 검색합니다. D:\exclude_list_external.txt에 있는 제외 목록 파일을 사용하여 보고할 문제점 수를 줄입니다.

스캔하는 중 org.eclipse.test.bundle의 /libs/contributed.jar 아카이브에 있는 클래스 파일은 무시합니다.

디버그가 사용 가능한 경우, 일부 디버그 추적이 Ant 콘솔에 표시됩니다.

관련 참조

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