JavaTM 2 Platform
Standard Ed. 6

javax.annotation.processing
介面 RoundEnvironment


public interface RoundEnvironment

註釋處理工具框架將提供一個註釋處理器和一個實作此介面的物件,這樣處理器可以查詢有關註釋處理的 round 的資訊。

從以下版本開始:
1.6

方法摘要
 boolean errorRaised()
          如果在以前的處理 round 中發生錯誤,則返回 true;否則返回 false
 Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
          返回使用給定註釋型別註釋的元素。
 Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
          返回使用給定註釋型別註釋的元素。
 Set<? extends Element> getRootElements()
          返回以前的 round 產生的註釋處理根元素。
 boolean processingOver()
          如果此 round 產生的型別不是以註釋處理的後續 round 為準,則返回 true;否則返回 false
 

方法詳細資訊

processingOver

boolean processingOver()
如果此 round 產生的型別不是以註釋處理的後續 round 為準,則返回 true;否則返回 false

返回:
如果此 round 產生的型別不是以註釋處理的後續 round 為準,則返回 true;否則返回 false

errorRaised

boolean errorRaised()
如果在以前的處理 round 中發生錯誤,則返回 true;否則返回 false

返回:
如果在以前的處理 round 中發生錯誤,則返回 true;否則返回 false

getRootElements

Set<? extends Element> getRootElements()
返回以前的 round 產生的註釋處理根元素。

返回:
返回以前的 round 產生的註釋處理根元素;如果沒有這樣的元素,則返回一個空集

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
返回使用給定註釋型別註釋的元素。該註釋可能直接出現或者被繼承。只返回註釋處理的此 round 中包括 的 package 元素和 type 元素、成員宣告、參數或者這些元素中宣告的型別參數。所包括的 type 元素是根型別和巢狀在這些型別中的所有成員型別。包中的元素不認為被包含在內,因為已經為該套件創建了一個 package-info 檔案。

參數:
a - 將被請求的註釋型別
返回:
使用給定註釋型別註釋的元素;如果沒有這樣的元素,則返回一個空集
拋出:
IllegalArgumentException - 如果參數不表示註釋型別

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
返回使用給定註釋型別註釋的元素。該註釋可能直接出現或者被繼承。只返回註釋處理的此 round 中包括 的 package 元素和 type 元素、成員宣告、參數或者這些元素中宣告的型別參數。所包括的 type 元素是根型別和巢狀在這些型別中的所有成員型別。包中的元素不認為被包含在內,因為已經為該套件創建了一個 package-info 檔案。

參數:
a - 將被請求的註釋型別
返回:
使用給定註釋型別註釋的元素;如果沒有這樣的元素,則返回一個空集
拋出:
IllegalArgumentException - 如果參數不表示註釋型別

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only