javax.annotation.processing

インタフェース Messager

public interface Messager

Messager は、エラーメッセージ、警告、およびほかの通知を報告する機能を注釈プロセッサに提供します。メッセージの位置に関するヒントを提供する目的で、要素、注釈、および注釈値を渡すことができます。ただし、そのような位置のヒントは、使用不可能であるか概算値にすぎない可能性があります。

種類としてエラーを指定してメッセージを出力すると、エラーが発行されます。

このインタフェースのメソッドを使って「出力」されるメッセージは、System.out や System.err などの場所へのテキスト出力として表示される場合もあれば、されない場合もあります。メッセージをウィンドウ内に表示するなど、この情報を別の方法で表示することを、実装が選択する可能性があります。

導入されたバージョン:

1.6

関連項目:

ProcessingEnvironment.getLocale()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	printMessage(Diagnostic.Kind kind, CharSequence msg) 指定された種類のメッセージを出力します。
void	printMessage(Diagnostic.Kind kind, CharSequence msg, Element e) 要素の位置における、指定された種類のメッセージを出力します。
void	printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a) 注釈の付いた要素の注釈ミラーの位置における、指定された種類のメッセージを出力します。
void	printMessage(Diagnostic.Kind kind, CharSequence msg, Element e, AnnotationMirror a, AnnotationValue v) 注釈の付いた要素の注釈ミラーに含まれる注釈値の位置における、指定された種類のメッセージを出力します。

メソッドの詳細

printMessage

void printMessage(Diagnostic.Kind kind,
                CharSequence msg)

指定された種類のメッセージを出力します。

パラメータ:

kind - メッセージの種類

msg - メッセージ、ない場合は空の文字列

printMessage

void printMessage(Diagnostic.Kind kind,
                CharSequence msg,
                Element e)

要素の位置における、指定された種類のメッセージを出力します。

パラメータ:

kind - メッセージの種類

msg - メッセージ、ない場合は空の文字列

e - 位置のヒントとして使用する要素

printMessage

void printMessage(Diagnostic.Kind kind,
                CharSequence msg,
                Element e,
                AnnotationMirror a)

注釈の付いた要素の注釈ミラーの位置における、指定された種類のメッセージを出力します。

パラメータ:

kind - メッセージの種類

msg - メッセージ、ない場合は空の文字列

e - 注釈の付いた要素

a - 位置のヒントとして使用する注釈

printMessage

void printMessage(Diagnostic.Kind kind,
                CharSequence msg,
                Element e,
                AnnotationMirror a,
                AnnotationValue v)

注釈の付いた要素の注釈ミラーに含まれる注釈値の位置における、指定された種類のメッセージを出力します。

パラメータ:

kind - メッセージの種類

msg - メッセージ、ない場合は空の文字列

e - 注釈の付いた要素

a - 注釈値を含む注釈

v - 位置のヒントとして使用する注釈値