Module de.codecamp.messages.core
Package de.codecamp.messages

Annotation Interface MessagesFor

@Target({TYPE,METHOD}) @Retention(RUNTIME) @Repeatable(Container.class) @Documented public @interface MessagesFor
This annotation is used to declare message keys for types that cannot be annotated directly. This means @MessagesFor(type=SomeType.class, ...) is equivalent to annotating SomeType directly using @Messages(...).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    MessagesFor.Container
    Container for repeated @MessagesFor annotations.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<?>
    type
    Returns the type that should be treated as the source type, i.e.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    forProperties
    Returns whether message keys for all bean properties of the annotated type should be created.
    boolean
    forType
    Returns whether a message key for the annotated type should be created.
    String[]
    ignoreImplicitKeys
    Returns a list of message keys that should be ignored for message key creation, like specfic bean properties or enum elements.
    String[]
    keys
    (Additional) Message keys.
    String
    prefix
    The prefix to be used for message keys.
    String[]
    value
    (Additional) Message keys.

  • Element Details

    • type

      Class<?> type
      Returns the type that should be treated as the source type, i.e. if it were annotated with Messages directly.
      Returns:
      the type that should be treated as the source type, i.e. if it were annotated with Messages directly

    • forType

      boolean forType
      Returns whether a message key for the annotated type should be created. Only relevant when the annotation is directly on the type.
      Returns:
      whether a message key for the annotated type should be created
      Default:
      false

    • forProperties

      boolean forProperties
      Returns whether message keys for all bean properties of the annotated type should be created. Only relevant on classes.
      Returns:
      whether message keys for all bean properties of the annotated type should be created
      Default:
      false

    • ignoreImplicitKeys

      String[] ignoreImplicitKeys
      Returns a list of message keys that should be ignored for message key creation, like specfic bean properties or enum elements.
      Returns:
      whether the annotated element should be ignored for the implicit generation of message keys
      Default:
      {}

    • prefix

      String prefix
      The prefix to be used for message keys. This can only be set if this annotation is at the type level. If not set, the fully qualified name of the source type is used.
      Returns:
      prefix to be used for message keys
      Default:
      "__SOURCE_TYPE__"

    • value

      String[] value
      (Additional) Message keys. The provided strings will be used as local parts in the message keys. This is an alias for keys().
      Returns:
      message keys
      Default:
      {}

    • keys

      String[] keys
      (Additional) Message keys. The provided strings will be used as local parts in the message keys. This is an alias for value().
      Returns:
      message keys
      Default:
      {}