Package org.mapstruct.ap.internal.util

Interface FormattingMessager

All Known Implementing Classes:

MapperAnnotatedFormattingMessenger

public interface FormattingMessager

Prints out diagnostics raised by the annotation processor. Messages are Java format strings taking the given arguments for interpolation.

Author:

Sjaak Derksen

Method Summary

Modifier and Type	Method	Description
boolean	isErroneous()
void	note(int level, Message log, Object... args)	Just log as plain note
void	printMessage(Element e, AnnotationMirror a, AnnotationValue v, Message msg, Object... args)	Prints a message of the specified kind at the location of the annotation value inside the annotation positionHint of the annotated element.
void	printMessage(Element e, AnnotationMirror a, Message msg, Object... args)	Prints a message of the specified kind at the location of the annotation positionHint of the annotated element.
void	printMessage(Element e, Message msg, Object... args)	Prints a message of the specified kind at the location of the element.
void	printMessage(Message msg, Object... args)	Prints a message of the specified kind.

Method Detail

printMessage

void printMessage(Message msg,
                  Object... args)

Prints a message of the specified kind.

Parameters:

msg - the message

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored

printMessage

void printMessage(Element e,
                  Message msg,
                  Object... args)

Prints a message of the specified kind at the location of the element.

Parameters:

e - the element to use as a position hint

msg - the message

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored

printMessage

void printMessage(Element e,
                  AnnotationMirror a,
                  Message msg,
                  Object... args)

Prints a message of the specified kind at the location of the annotation positionHint of the annotated element.

Parameters:

e - the annotated element

a - the annotation to use as a position hint (can be null)

msg - the message

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored

printMessage

void printMessage(Element e,
                  AnnotationMirror a,
                  AnnotationValue v,
                  Message msg,
                  Object... args)

Prints a message of the specified kind at the location of the annotation value inside the annotation positionHint of the annotated element.

Parameters:

e - the annotated element

a - the annotation containing the annotation value

v - the annotation value to use as a position hint

msg - the message

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored

note

void note(int level,
          Message log,
          Object... args)

Just log as plain note

Parameters:

level - nesting level

log - the log message

args - the arguments

isErroneous

boolean isErroneous()