Top Description Methods
org.jboss.logging.annotations

public @Interface MessageBundle

extends Annotation
Annotations
@Target:TYPE
@Retention:CLASS
@Documented
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.CLASS

Signify that an interface is a message bundle interface.
Author
David M. Lloyd

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the length the id should be padded
length
()

The length of the padding used for each id in the message bundle.

public String

Returns:

the project code
projectCode
()

Get the project code for messages that have an associated code.

public String

Returns:

the default locale message bundles should use for formatting messages
rootLocale
()

Specifies the locale for formatting bundle messages.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

lengthback to summary
public int length()

The length of the padding used for each id in the message bundle. For example given the default padding length of 6 and a message with an id of 100 would result would be "000100".

Valid values a range of 3 to 8. Any value less than 0 turns off padding. Any other value will result in an error being produced.

Returns:int

the length the id should be padded

projectCodeback to summary
public String projectCode()

Get the project code for messages that have an associated code. If no project code is associated with this bundle, specify "" (the empty string).

Returns:String

the project code

rootLocaleback to summary
public String rootLocale()

Specifies the locale for formatting bundle messages. This is only used in the super implementation. Subclasses will define their own locale to use based on the name of the resource bundle at compile time.

An empty string will default to Locale#ROOT.

A non-empty string will be parsed by the Locale#forLanguageTag(String). This uses the IETF BCP 47 format.

Returns:String

the default locale message bundles should use for formatting messages