-
public interface ProcessingEnvironment
An annotation processing tool framework will provide an annotation processor with an object implementing this interface so the processor can use facilities provided by the framework to write new files, report error messages, and find other utilities.Third parties may wish to provide value-add wrappers around the facility objects from this interface, for example a
Filer
extension that allows multiple processors to coordinate writing out a single source file. To enable this, for processors running in a context where their side effects via the API could be visible to each other, the tool infrastructure must provide corresponding facility objects that are.equals
,Filer
s that are.equals
, and so on. In addition, the tool invocation must be able to be configured such that from the perspective of the running annotation processors, at least the chosen subset of helper classes are viewed as being loaded by the same class loader. (Since the facility objects manage shared state, the implementation of a wrapper class must know whether or not the same base facility object has been wrapped before.)- Since:
- 1.6
-
-
Method Summary
Methods Modifier and Type Method and Description Elements
getElementUtils()
Returns an implementation of some utility methods for operating on elementsFiler
getFiler()
Returns the filer used to create new source, class, or auxiliary files.Locale
getLocale()
Returns the current locale ornull
if no locale is in effect.Messager
getMessager()
Returns the messager used to report errors, warnings, and other notices.Map<String,String>
getOptions()
Returns the processor-specific options passed to the annotation processing tool.SourceVersion
getSourceVersion()
Types
getTypeUtils()
Returns an implementation of some utility methods for operating on types.
-
-
-
Method Detail
-
getOptions
Map<String,String> getOptions()
Returns the processor-specific options passed to the annotation processing tool. Options are returned in the form of a map from option name to option value. For an option with no value, the corresponding value in the map isnull
.See documentation of the particular tool infrastructure being used for details on how to pass in processor-specific options. For example, a command-line implementation may distinguish processor-specific options by prefixing them with a known string like
"-A"
; other tool implementations may follow different conventions or provide alternative mechanisms. A given implementation may also provide implementation-specific ways of finding options passed to the tool in addition to the processor-specific options.- Returns:
- the processor-specific options passed to the tool
-
getMessager
Messager getMessager()
Returns the messager used to report errors, warnings, and other notices.- Returns:
- the messager
-
getFiler
Filer getFiler()
Returns the filer used to create new source, class, or auxiliary files.- Returns:
- the filer
-
getElementUtils
Elements getElementUtils()
Returns an implementation of some utility methods for operating on elements- Returns:
- element utilities
-
getTypeUtils
Types getTypeUtils()
Returns an implementation of some utility methods for operating on types.- Returns:
- type utilities
-
getSourceVersion
SourceVersion getSourceVersion()
- Returns:
- the source version to which generated source and class files should conform to
- See Also:
Processor.getSupportedSourceVersion()
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/annotation/processing/processingenvironment.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.