|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME) @Documented @Target(value={TYPE,FIELD}) public @interface MessageParamsDescriptor
Provides a reference to a type that provides information about the message parameters that are used by the code's message templates. Usually this is one of the exceptions that uses the code and contains fields that are annotated with the MessageParam
annotation.
If the code, the element in the enumeration of codes, is annotated with this annotation, the parser is able to deduct additional information for reports. Therefore using this annotation is optional and should only be considered, if reports on the template placeholders are required. This is for example the case, if you want to translate the original messages to other languages. In this case a documentation of the available placeholders in the text is quite useful for the translator.
If a type is annotated, the annotation refers to any field of that type, unless the field has its own annotation.
Required Element Summary | |
---|---|
Class<?> |
value The class that provides further information about the annotated element. |
Element Detail |
---|
public abstract Class<?> value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |