net.sf.mmm.util.nls.base

Class NlsBundleDescriptor

java.lang.Object

net.sf.mmm.util.nls.base.NlsBundleDescriptor

public class NlsBundleDescriptor
extends Object

This is the descriptor of an NlsBundle or ResourceBundle.

Since:

7.3.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private NlsBundleHelper	bundleHelper
private String	name
private Class<? extends NlsBundle>	nlsBundleInterface The NlsBundle-interface or null if resourceBundle is given.
private String	packageName
private String	packagePath
private Map<String,NlsMessageDescriptor>	properties
private String	qualifiedName
private String	qualifiedNamePath
private ResourceBundle	resourceBundle The ResourceBundle or null if nlsBundleInterface is given.

Constructor Summary

Constructors

Modifier	Constructor and Description
	NlsBundleDescriptor(Class<? extends NlsBundle> nlsBundleInterface) The constructor.
private	NlsBundleDescriptor(Class<? extends NlsBundle> nlsBundleInterface, ResourceBundle resourceBundle)
private	NlsBundleDescriptor(Class<? extends NlsBundle> nlsBundleInterface, ResourceBundle resourceBundle, NlsBundleHelper bundleHelper)
	NlsBundleDescriptor(ResourceBundle resourceBundle) The constructor.

Method Summary

Modifier and Type	Method and Description
private NlsArgumentDescriptor[]	getArguments(String message)
NlsMessageDescriptor	getMessage(String key)
NlsMessageDescriptor	getMessageRequired(String key)
Map<String,NlsMessageDescriptor>	getMessages()
String	getName()
String	getPackageName()
String	getPackagePath()
String	getQualifiedName()
String	getQualifiedNamePath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

resourceBundle

private final ResourceBundle resourceBundle

The ResourceBundle or null if nlsBundleInterface is given.

nlsBundleInterface

private final Class<? extends NlsBundle> nlsBundleInterface

The NlsBundle-interface or null if resourceBundle is given.

properties

private Map<String,NlsMessageDescriptor> properties

qualifiedName

private final String qualifiedName

packageName

private final String packageName

packagePath

private final String packagePath

qualifiedNamePath

private final String qualifiedNamePath

name

private final String name

bundleHelper

private final NlsBundleHelper bundleHelper

Constructor Detail

NlsBundleDescriptor

public NlsBundleDescriptor(ResourceBundle resourceBundle)

The constructor.

Parameters:

resourceBundle - is the ResourceBundle.

NlsBundleDescriptor

public NlsBundleDescriptor(Class<? extends NlsBundle> nlsBundleInterface)

The constructor.

Parameters:

nlsBundleInterface - is the NlsBundle interface.

NlsBundleDescriptor

private NlsBundleDescriptor(Class<? extends NlsBundle> nlsBundleInterface,
                            ResourceBundle resourceBundle)

NlsBundleDescriptor

private NlsBundleDescriptor(Class<? extends NlsBundle> nlsBundleInterface,
                            ResourceBundle resourceBundle,
                            NlsBundleHelper bundleHelper)

Method Detail

getQualifiedName

public String getQualifiedName()

Returns:

the fully qualified name of the bundle in java class notation.

getQualifiedNamePath

public String getQualifiedNamePath()

Returns:

the qualified name as path (e.g. "net/sf/mmm/util/cli/NlsBundleUtilCli" for name "net.sf.mmm.util.cli.NlsBundleUtilCli").

getName

public String getName()

Returns:

the name

getPackageName

public String getPackageName()

Returns:

the Package name.

getPackagePath

public String getPackagePath()

Returns:

the package name as path (e.g. "net/sf/mmm/util/cli" for name "net.sf.mmm.util.cli").

getMessages

public Map<String,NlsMessageDescriptor> getMessages()

Returns:

the properties as key/value Map.

getMessage

public NlsMessageDescriptor getMessage(String key)

Parameters:

key - the key of the requested message.

Returns:

the NlsMessageDescriptor for the given key or null if not present.

getMessageRequired

public NlsMessageDescriptor getMessageRequired(String key)

Parameters:

key - the key of the requested message.

Returns:

the NlsMessageDescriptor for the given key or null if not present.

getArguments

private NlsArgumentDescriptor[] getArguments(String message)