javax.annotation.processing
클래스 AbstractProcessor

java.lang.Object 
  javax.annotation.processing.AbstractProcessor

모든 구현된 인터페이스:

Processor

public abstract class AbstractProcessor
extends Object 
implements Processor 

대부분의 구상 주석 프로세서의 간이 슈퍼 클래스로서 설계된, 추상 주석 프로세서. 이 클래스는, 주석의 값을 검사하는 것으로, 그 서브형이 지원하는 옵션,주석, 및 소스 버젼 을 계산합니다.

getter 메소드는, 프로세서의 초기화 후에 사용 가능해지는 기능을 사용해, 통지하는 가치가 있는 상태에 관한 경고를 발행 할 가능성이 있습니다.

서브 클래스는, 이 클래스내의 임의의 메소드의 구현이나 스펙을 자유롭게 오버라이드(override) 할 수 있습니다. 다만 그 때, 그 메소드에 대한 Processor 의 일반 규약에는 따를 필요가 있습니다.

도입된 버젼:

1.6

필드의 개요

protected ProcessingEnvironment

processingEnv 툴 시스템에 의해 제공된 처리 환경.

생성자 의 개요

protected

AbstractProcessor () 서브 클래스가 호출하기 위한 생성자.

메소드의 개요

Iterable <? extends Completion >	getCompletions (Element element, AnnotationMirror annotation, ExecutableElement member, String userText) 컴플리트의 빈 상태(empty)의 반복 가능 객체를 돌려줍니다.
Set <String >	getSupportedAnnotationTypes () 프로세서 클래스에 SupportedAnnotationTypes 의 주석을 붙일 수 있고 있는 경우, 그 주석과 같은 캐릭터 라인 세트를 포함한 변경 불가능한 세트를 돌려줍니다.
Set <String >	getSupportedOptions () 프로세서 클래스에 SupportedOptions 의 주석을 붙일 수 있고 있는 경우, 그 주석과 같은 캐릭터 라인 세트를 포함한 변경 불가능한 세트를 돌려줍니다.
SourceVersion	getSupportedSourceVersion () 프로세서 클래스에 SupportedSourceVersion 의 주석을 붙일 수 있고 있는 경우, 그 주석내의 소스 버젼을 돌려줍니다.
void	init (ProcessingEnvironment processingEnv) 처리 환경을 사용해 프로세서를 초기화하기 위해서,processingEnv 필드를 processingEnv 인수의 값으로 설정합니다.
protected boolean	isInitialized () 이 객체가 초기화가 끝난 상태 인 경우는 true 를 돌려주어, 그 이외의 경우는 false 를 돌려줍니다.
abstract boolean	process (Set <? extends TypeElement > annotations, RoundEnvironment roundEnv) 전회의 라운드로 생성된 형태 요소의 주석형세트를 처리해, 이 프로세서가 그러한 주석을 요구할지 어떨지를 돌려줍니다.

클래스 java.lang. Object 로부터 상속된 메소드

clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

필드의 상세

processingEnv

protected ProcessingEnvironment  processingEnv

툴 시스템에 의해 제공된 처리 환경.

생성자 의 상세

AbstractProcessor

protected AbstractProcessor()

서브 클래스가 호출하기 위한 생성자.

메소드의 상세

getSupportedOptions

public Set <String > getSupportedOptions()

프로세서 클래스에 SupportedOptions 의 주석을 붙일 수 있고 있는 경우, 그 주석과 같은 캐릭터 라인 세트를 포함한 변경 불가능한 세트를 돌려줍니다. 클래스에 그러한 주석을 붙일 수 있지 않은 경우는, 빈 상태(empty)세트가 돌려주어집니다.

정의:

인터페이스 Processor 내의 getSupportedOptions

반환값:

이 프로세서가 인식하는 옵션. 존재하지 않는 경우는 빈 상태(empty)세트

관련 항목:

SupportedOptions

getSupportedAnnotationTypes

public Set <String > getSupportedAnnotationTypes()

프로세서 클래스에 SupportedAnnotationTypes 의 주석을 붙일 수 있고 있는 경우, 그 주석과 같은 캐릭터 라인 세트를 포함한 변경 불가능한 세트를 돌려줍니다. 클래스에 그러한 주석을 붙일 수 있지 않은 경우는, 빈 상태(empty)세트가 돌려주어집니다.

정의:

인터페이스 Processor 내의 getSupportedAnnotationTypes

반환값:

이 프로세서가 지원하는 주석형의 이름. 존재하지 않는 경우는 빈 상태(empty)세트

관련 항목:

SupportedAnnotationTypes

getSupportedSourceVersion

public SourceVersion  getSupportedSourceVersion()

프로세서 클래스에 SupportedSourceVersion 의 주석을 붙일 수 있고 있는 경우, 그 주석내의 소스 버젼을 돌려줍니다. 클래스에 그러한 주석을 붙일 수 있지 않은 경우는,SourceVersion.RELEASE_6 가 돌려주어집니다.

정의:

인터페이스 Processor 내의 getSupportedSourceVersion

반환값:

이 프로세서가 지원하는 최신 소스 버젼

관련 항목:

SupportedSourceVersion , ProcessingEnvironment.getSourceVersion()

init

public void init(ProcessingEnvironment  processingEnv)

처리 환경을 사용해 프로세서를 초기화하기 위해서,processingEnv 필드를 processingEnv 인수의 값으로 설정합니다. 이 메소드가 같은 객체상에서 2 회 이상 불려 가면(자),IllegalStateException 가 throw 됩니다.

정의:

인터페이스 Processor 내의 init

파라미터:

processingEnv - 툴 시스템가 프로세서에 대해서 제공하는 기능에 액세스하기 위한 환경

예외:

IllegalStateException - 이 메소드가 2 회 이상 불려 갔을 경우

process

public abstract boolean process(Set <?  extends TypeElement > annotations,
                                RoundEnvironment  roundEnv)

전회의 라운드로 생성된 형태 요소의 주석형세트를 처리해, 이 프로세서가 그러한 주석을 요구할지 어떨지를 돌려줍니다. true 가 돌려주어졌을 경우, 그러한 주석은 요구되어 후속의 프로세서가 그러한 처리를 의뢰받을 것은 없습니다. false 가 돌려주어졌을 경우, 그러한 주석은 요구되지 않고, 후속의 프로세서는 아마 그러한 처리를 의뢰받습니다. 프로세서는, 항상 같은 boolean 치를 돌려주는 일도, 선택된 조건에 근거해 결과를 바꿀 수도 있습니다.

프로세서가 「*」 을 지원하고 있어 루트 요소가 주석을 1 개도 가지지 않는 경우, 입력세트는 비웁니다. Processor 는 빈 상태(empty)의 주석 세트를 적절히 처리하지 않으면 안됩니다.

정의:

인터페이스 Processor 내의 process

파라미터:

annotations - 처리가 요구된 주석형

roundEnv - 현재 및 전회의 라운드에 대한 정보에 대한 환경

반환값:

이 프로세서가 주석세트를 요구할지 어떨지

getCompletions

public Iterable <?  extends Completion > getCompletions(Element  element,
                                                     AnnotationMirror  annotation,
                                                     ExecutableElement  member,
                                                     String  userText)

컴플리트의 빈 상태(empty)의 반복 가능 객체를 돌려줍니다.

정의:

인터페이스 Processor 내의 getCompletions

파라미터:

element - 주석을 붙일 수 있는 요소

annotation - element 에 적용되는 (아마 부분적인) 주석

member - 가능한 컴플리트를 돌려주는 대상이 되는 주석 멤버

userText - 컴플리트의 대상이 되는 원시 코드 텍스트

반환값:

주석에 대한 추천의 컴플리트

isInitialized

protected boolean isInitialized()

이 객체가 초기화가 끝난 상태 인 경우는 true 를 돌려주어, 그 이외의 경우는 false 를 돌려줍니다.

반환값:

이 객체가 초기화가 끝난 상태인 경우는 true, 그 이외의 경우는 false