Module xaos.tools

Annotation Type BundleItem


  • @Documented
    @Repeatable(BundleItems.class)
    @Retention(SOURCE)
    @Target({CONSTRUCTOR,FIELD,METHOD,TYPE})
    public @interface BundleItem
    This annotation define a single entry in the resource bundle file.

    By default a resource bundle named "Bundle.properties" will be created inside the package of the class or interface annotated by this annotation. If the file already exists, the entry line for this annotation will be appended.

    The Bundle annotation can be used to provide a different name to the resource bundle file.

    Author:
    claudio.rosati@esss.se
    See Also:
    Bundles
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String key
      The item key in the resource bundle.
      String message
      The item message in the resource bundle.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String comment
      An optional comment to be inserted before the item in the resource bundle.
    • Element Detail

      • key

        String key
        The item key in the resource bundle. It is mandatory and must be unique in the resource bundle.
        Returns:
        The item key.
      • message

        String message
        The item message in the resource bundle. If the resource bundle will be localized, the returned value will be considered being the "default" message.
        Returns:
        The item message.
      • comment

        String comment
        An optional comment to be inserted before the item in the resource bundle.
        Returns:
        A comment to the resource item.
        Default:
        ""