com.github.misberner.apcommons.reporting

Class AnnotationReporter

java.lang.Object

com.github.misberner.apcommons.reporting.AbstractReporter

com.github.misberner.apcommons.reporting.RootReporter

com.github.misberner.apcommons.reporting.ElementReporter

com.github.misberner.apcommons.reporting.AnnotationReporter

All Implemented Interfaces:

Reporter

Direct Known Subclasses:

ValueReporter

public class AnnotationReporter
extends ElementReporter

Reporter that by default prints messages associated with a certain annotation of a certain element.

Author:

Malte Isberner

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationMirror	annotation

Fields inherited from class com.github.misberner.apcommons.reporting.ElementReporter

element

Fields inherited from class com.github.misberner.apcommons.reporting.RootReporter

processingEnv

Constructor Summary

Constructors

Constructor and Description
AnnotationReporter(ProcessingEnvironment processingEnv, Element element, AnnotationMirror annotation) Constructor.
AnnotationReporter(ProcessingEnvironment processingEnv, Element element, CharSequence annotationName)
AnnotationReporter(ProcessingEnvironment processingEnv, Element element, Class<? extends Annotation> annotationClazz)

Method Summary

Methods

Modifier and Type	Method and Description
ValueReporter	forValue(AnnotationValue value) Retrieves a reporter which prints messages corresponding to a certain value of the annotation.
ValueReporter	forValue(CharSequence valueName) Retrieves a reporter which prints messages corresponding to a certain value of the annotation.
protected void	printMessage(Diagnostic.Kind kind, CharSequence message) Actually print a message of the given diagnostic kind.

Methods inherited from class com.github.misberner.apcommons.reporting.ElementReporter

forAnnotation, forAnnotation, forAnnotation

Methods inherited from class com.github.misberner.apcommons.reporting.RootReporter

forElement

Methods inherited from class com.github.misberner.apcommons.reporting.AbstractReporter

assembleMessage, error, mandatoryWarning, message, note, other, warning

Methods inherited from class java.lang.Object

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

Field Detail

annotation

protected AnnotationMirror annotation

Constructor Detail

AnnotationReporter

public AnnotationReporter(ProcessingEnvironment processingEnv,
                  Element element,
                  AnnotationMirror annotation)

Constructor.

Parameters:

processingEnv - the processing environment

element - the element to which messages refer

annotation - the annotation to which messages refer

AnnotationReporter

public AnnotationReporter(ProcessingEnvironment processingEnv,
                  Element element,
                  CharSequence annotationName)

AnnotationReporter

public AnnotationReporter(ProcessingEnvironment processingEnv,
                  Element element,
                  Class<? extends Annotation> annotationClazz)

Method Detail

printMessage

protected void printMessage(Diagnostic.Kind kind,
                CharSequence message)

Description copied from class: AbstractReporter

Actually print a message of the given diagnostic kind.

Overrides:

printMessage in class ElementReporter

Parameters:

kind - the diagnostic kind

message - the message to print

forValue

public ValueReporter forValue(CharSequence valueName)

Retrieves a reporter which prints messages corresponding to a certain value of the annotation.

Parameters:

valueName - the name of the annotation value

Returns:

the corresponding reporter

forValue

public ValueReporter forValue(AnnotationValue value)

Retrieves a reporter which prints messages corresponding to a certain value of the annotation.

Parameters:

value - the annotation value

Returns:

the corresponding reporter