net.sf.mmm.util.nls.base

Class NlsMessageDescriptor

java.lang.Object

net.sf.mmm.util.nls.base.NlsMessageDescriptor

public class NlsMessageDescriptor
extends Object

This is the descriptor of an NlsMessage from an NlsBundle Method.

Since:

7.3.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private NlsArgumentDescriptor[]	arguments
private String	key
private String	message
private Method	method

Constructor Summary

Constructors

Constructor and Description
NlsMessageDescriptor(Method method) The constructor.
NlsMessageDescriptor(String key, String message, NlsArgumentDescriptor[] arguments) The constructor.

Method Summary

Modifier and Type	Method and Description
NlsArgumentDescriptor	getArgument(int index)
NlsArgumentDescriptor	getArgument(String argumentKey)
int	getArgumentCount()
private NlsArgumentDescriptor[]	getArguments()
String	getKey()
String	getMessage()
Method	getMethod()

Methods inherited from class java.lang.Object

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

Field Detail

method

private final Method method

key

private final String key

message

private final String message

arguments

private NlsArgumentDescriptor[] arguments

Constructor Detail

NlsMessageDescriptor

NlsMessageDescriptor(Method method)

The constructor.

Parameters:

method - the NlsBundle Method.

bundleHelper - the NlsBundleHelper instance.

NlsMessageDescriptor

public NlsMessageDescriptor(String key,
                            String message,
                            NlsArgumentDescriptor[] arguments)

The constructor.

Parameters:

key - - see getKey().

message - - see getMessage().

arguments - - see getArgument(int).

Method Detail

getMethod

public Method getMethod()

Returns:

the method

getKey

public String getKey()

Returns:

the key

getMessage

public String getMessage()

Returns:

the message

getArguments

private NlsArgumentDescriptor[] getArguments()

getArgument

public NlsArgumentDescriptor getArgument(int index)

Parameters:

index - the index of the requested NlsArgumentDescriptor in the range from 0 to getArgumentCount() - 1.

Returns:

the NlsArgumentDescriptor for the given index.

getArgumentCount

public int getArgumentCount()

Returns:

the number of arguments.

getArgument

public NlsArgumentDescriptor getArgument(String argumentKey)

Parameters:

argumentKey - the key of the requested NlsArgumentDescriptor.

Returns:

the NlsArgumentDescriptor for the given key or null if not found.