de.japkit.services

Class MessageCollector

java.lang.Object

de.japkit.services.MessageCollector

public class MessageCollector
extends Object

Collects error messages for annotated classes.

While it might seem sufficient to use the ProcessingEnvironment.Messager for this, it is not... Eclipse tends to "forget" reported errors in some cases, especially, when annotated classes refer to generated classes and Eclipse has to compile them again after an annotation processor round. Thus, we collect all errors and report them in last annotation processing round. See: https://bugs.eclipse.org/bugs/show_bug.cgi?id=419769

Constructor Summary

Constructors

Constructor and Description
MessageCollector()

Method Summary

Modifier and Type	Method and Description
protected void	_reportRuleError(CharSequence msg)
protected void	_reportRuleError(CharSequence msg, CharSequence metaAnnotationValueName)
protected void	_reportRuleError(ELProviderException e, CharSequence metaAnnotationValueName)
protected void	_reportRuleError(Exception e)
protected void	_reportRuleError(Exception e, CharSequence metaAnnotationValueName)
protected void	_reportRuleError(RuleException e, CharSequence metaAnnotationValueName)
void	addMessage(Diagnostic.Kind kind, String msg, Element element, AnnotationMirror annotation, String annotationValueName)
void	addMessage(Message m)
AnnotationMirror	getNestedAnnotation(AnnotationMirror rootAnnotation, Path path)
AnnotationValue	getValue(AnnotationMirror am, String avName, Integer index)
boolean	isDiagnosticLogging()
boolean	isEclipse()
void	printAllMessages()
void	printDiagnosticMessage(Element e, org.eclipse.xtext.xbase.lib.Functions.Function1<? super Object,? extends CharSequence> cs)
void	printDiagnosticMessage(org.eclipse.xtext.xbase.lib.Functions.Function1<? super Object,? extends CharSequence> cs)
Set<Message>	removeMessagesForAnnotatedClass(String annotatedClassFqn)
void	reportError(CharSequence msg, Element element, AnnotationMirror annotation, CharSequence annotationValueName)
void	reportError(CharSequence msg, Exception ex, Element element, AnnotationMirror annotation, CharSequence annotationValueName)
void	reportError(ProcessingException pe)
void	reportMessage(String msg, Element element, Diagnostic.Kind kind)
void	reportRuleError(Object e)
void	reportRuleError(Object e, CharSequence metaAnnotationValueName)
void	reportRuleError(Rule rule, CharSequence msg, CharSequence metaAnnotationValueName)
void	setDiagnosticLogging(boolean diagnosticLogging)
boolean	supportsNestedAnnotations()

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageCollector

public MessageCollector()

Method Detail

addMessage

public void addMessage(Message m)

addMessage

public void addMessage(Diagnostic.Kind kind,
                       String msg,
                       Element element,
                       AnnotationMirror annotation,
                       String annotationValueName)

printAllMessages

public void printAllMessages()

supportsNestedAnnotations

public boolean supportsNestedAnnotations()

isEclipse

public boolean isEclipse()

getNestedAnnotation

public AnnotationMirror getNestedAnnotation(AnnotationMirror rootAnnotation,
                                            Path path)

getValue

public AnnotationValue getValue(AnnotationMirror am,
                                String avName,
                                Integer index)

removeMessagesForAnnotatedClass

public Set<Message> removeMessagesForAnnotatedClass(String annotatedClassFqn)

_reportRuleError

protected void _reportRuleError(CharSequence msg)

_reportRuleError

protected void _reportRuleError(Exception e)

_reportRuleError

protected void _reportRuleError(ELProviderException e,
                                CharSequence metaAnnotationValueName)

_reportRuleError

protected void _reportRuleError(RuleException e,
                                CharSequence metaAnnotationValueName)

_reportRuleError

protected void _reportRuleError(Exception e,
                                CharSequence metaAnnotationValueName)

_reportRuleError

protected void _reportRuleError(CharSequence msg,
                                CharSequence metaAnnotationValueName)

reportRuleError

public void reportRuleError(Rule rule,
                            CharSequence msg,
                            CharSequence metaAnnotationValueName)

reportError

public void reportError(CharSequence msg,
                        Exception ex,
                        Element element,
                        AnnotationMirror annotation,
                        CharSequence annotationValueName)

reportError

public void reportError(CharSequence msg,
                        Element element,
                        AnnotationMirror annotation,
                        CharSequence annotationValueName)

reportError

public void reportError(ProcessingException pe)

reportMessage

public void reportMessage(String msg,
                          Element element,
                          Diagnostic.Kind kind)

printDiagnosticMessage

public void printDiagnosticMessage(org.eclipse.xtext.xbase.lib.Functions.Function1<? super Object,? extends CharSequence> cs)

printDiagnosticMessage

public void printDiagnosticMessage(Element e,
                                   org.eclipse.xtext.xbase.lib.Functions.Function1<? super Object,? extends CharSequence> cs)

reportRuleError

public void reportRuleError(Object e)

reportRuleError

public void reportRuleError(Object e,
                            CharSequence metaAnnotationValueName)

isDiagnosticLogging

@Pure
public boolean isDiagnosticLogging()

setDiagnosticLogging

public void setDiagnosticLogging(boolean diagnosticLogging)