Package ch.qos.cal10n

Annotation Type BaseName


  • @Retention(RUNTIME)
    @Target(TYPE)
    public @interface BaseName
    This annotation serves to designate the name of the resource bundle corresponding to an enum type.

    Typical usage is:

     @BaseName("colors");
     @LocaleData( { @Locale("en"), @Locale("jp") } )
     public class enum Colors {
       RED, WHITE, BLUE; 
     }
     

    In the above example, @BaseName("colors") means that there exists a family of resource bundle files with the base name "colors". In conjunction with the information provided in the @LocaleData annotation, we can assume that the files colors_en.properties and colors_jp.properties exist.

    Verification tools such as MessageKeyVerifier can then proceed to check that the keys defined in the enum type match those in the corresponding resource bundles.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value  
    • Element Detail

      • value

        java.lang.String value