Annotation Type Module

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      A human readable description for the module.
      java.lang.String id
      A stable identifier for the module.
      java.lang.String name
      A human readable name for the module.
      java.lang.String value
      An alias for name().
    • Element Detail

      • id

        java.lang.String id
        A stable identifier for the module. If not defined, an identifier will be derived from the annotated element, usually a package. That allows tooling to derive name and description by applying some kind of convention to the identifier.

        Assuming a package com.acme.myapp.module annotated with Module, tooling could use a resource bundle to lookup the keys com.acme.myapp.module._name and com.acme.myapp.module_description to resolve name and description respectively.

        Returns:
        Default:
        ""
      • name

        java.lang.String name
        A human readable name for the module. Might be overridden by an external resolution mechanism via id(). Tooling should prevent both value() and name() from being configured at the same time. If in doubt, the value defined in name() will be preferred.
        Returns:
        See Also:
        id()
        Default:
        ""
      • value

        java.lang.String value
        An alias for name(). Tooling should prevent both value() and name() from being configured at the same time. If in doubt, the value defined in name() will be preferred.
        Returns:
        See Also:
        name()
        Default:
        ""
      • description

        java.lang.String description
        A human readable description for the module. Might be overridden by an external resolution mechanism via id().
        Returns:
        See Also:
        id()
        Default:
        ""