net.sf.mmm.util.nls.api

Interface NlsMessageFactory

All Known Implementing Classes:

AbstractNlsMessageFactory, AbstractNlsMessageFactoryImpl, NlsMessageFactoryImpl

@ComponentSpecification
public interface NlsMessageFactory

This is the interface for a factory used to create instances of NlsMessage.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
NlsMessage	create(NlsTemplate template) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(NlsTemplate template, Map<String,Object> messageArguments) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(NlsTemplate template, Object... messageArguments) Deprecated. use create(NlsTemplate, Map) instead.
NlsMessage	create(NlsTemplate template, String key1, Object argument1) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(NlsTemplate template, String key1, Object argument1, String key2, Object argument2) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(NlsTemplate template, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(NlsTemplate template, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3, String key4, Object argument4) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(String internationalizedMessage) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(String internationalizedMessage, Map<String,Object> messageArguments) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(String internationalizedMessage, Object... messageArguments) Deprecated. use create(String, Map) instead.
NlsMessage	create(String internationalizedMessage, String key1, Object argument1) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(String internationalizedMessage, String key1, Object argument1, String key2, Object argument2) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(String internationalizedMessage, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	create(String internationalizedMessage, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3, String key4, Object argument4) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	createDirect(String bundleName, String key) This method creates a new instance of NlsMessage from the given arguments.
NlsMessage	createDirect(String bundleName, String key, Map<String,Object> messageArguments) This method creates a new instance of NlsMessage from the given arguments.

Method Detail

create

@Deprecated
NlsMessage create(String internationalizedMessage,
                               Object... messageArguments)

Deprecated. use create(String, Map) instead.

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

messageArguments - are the arguments filled into the message after nationalization.

Returns:

the new NlsMessage instance.

create

@Deprecated
NlsMessage create(NlsTemplate template,
                               Object... messageArguments)

Deprecated. use create(NlsTemplate, Map) instead.

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

messageArguments - are the arguments filled into the message after nationalization.

Returns:

the new NlsMessage instance.

create

NlsMessage create(String internationalizedMessage,
                  String key1,
                  Object argument1)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

Returns:

the new NlsMessage instance.

create

NlsMessage create(NlsTemplate template,
                  String key1,
                  Object argument1)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

Returns:

the new NlsMessage instance.

create

NlsMessage create(String internationalizedMessage,
                  String key1,
                  Object argument1,
                  String key2,
                  Object argument2)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

key2 - is the key of the second argument.

argument2 - is the value of the second argument.

Returns:

the new NlsMessage instance.

create

NlsMessage create(NlsTemplate template,
                  String key1,
                  Object argument1,
                  String key2,
                  Object argument2)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

key2 - is the key of the second argument.

argument2 - is the value of the second argument.

Returns:

the new NlsMessage instance.

create

NlsMessage create(String internationalizedMessage,
                  String key1,
                  Object argument1,
                  String key2,
                  Object argument2,
                  String key3,
                  Object argument3)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

key2 - is the key of the second argument.

argument2 - is the value of the second argument.

key3 - is the key of the third argument.

argument3 - is the value of the third argument.

Returns:

the new NlsMessage instance.

create

NlsMessage create(NlsTemplate template,
                  String key1,
                  Object argument1,
                  String key2,
                  Object argument2,
                  String key3,
                  Object argument3)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

key2 - is the key of the second argument.

argument2 - is the value of the second argument.

key3 - is the key of the third argument.

argument3 - is the value of the third argument.

Returns:

the new NlsMessage instance.

create

NlsMessage create(String internationalizedMessage,
                  String key1,
                  Object argument1,
                  String key2,
                  Object argument2,
                  String key3,
                  Object argument3,
                  String key4,
                  Object argument4)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

key2 - is the key of the second argument.

argument2 - is the value of the second argument.

key3 - is the key of the third argument.

argument3 - is the value of the third argument.

key4 - is the key of the fourth argument.

argument4 - is the value of the fourth argument.

Returns:

the new NlsMessage instance.

Since:

1.1.1

create

NlsMessage create(NlsTemplate template,
                  String key1,
                  Object argument1,
                  String key2,
                  Object argument2,
                  String key3,
                  Object argument3,
                  String key4,
                  Object argument4)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

key1 - is the key of the first argument.

argument1 - is the value of the first argument.

key2 - is the key of the second argument.

argument2 - is the value of the second argument.

key3 - is the key of the third argument.

argument3 - is the value of the third argument.

key4 - is the key of the fourth argument.

argument4 - is the value of the fourth argument.

Returns:

the new NlsMessage instance.

Since:

1.1.1

create

NlsMessage create(String internationalizedMessage,
                  Map<String,Object> messageArguments)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

messageArguments - are the arguments filled into the message after nationalization.

Returns:

the new NlsMessage instance.

createDirect

NlsMessage createDirect(String bundleName,
                        String key)

This method creates a new instance of NlsMessage from the given arguments.
ATTENTION:
This us an uncommon way for creating an NlsMessage. It should only be used for specific cases where both NlsBundle and AbstractResourceBundle are NOT suitable. Please read net.sf.mmm.util.nls.api as motivation and introduction.

Parameters:

bundleName - is the base-name of the bundle containing the message.

key - is the key for the lookup. Will be used as fallback for the internationalized message.

Returns:

the new NlsMessage instance.

Since:

3.1.0

See Also:

createDirect(String, String, Map)

createDirect

NlsMessage createDirect(String bundleName,
                        String key,
                        Map<String,Object> messageArguments)

This method creates a new instance of NlsMessage from the given arguments.
ATTENTION:
This us an uncommon way for creating an NlsMessage. It should only be used for specific cases where both NlsBundle and AbstractResourceBundle are NOT suitable. Please read net.sf.mmm.util.nls.api as motivation and introduction.

Parameters:

bundleName - is the base-name of the bundle containing the message.

key - is the key for the lookup. Will be used as fallback for the internationalized message.

messageArguments - are the arguments filled into the message after nationalization.

Returns:

the new NlsMessage instance.

Since:

3.1.0

create

NlsMessage create(NlsTemplate template,
                  Map<String,Object> messageArguments)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

messageArguments - are the arguments filled into the message after nationalization.

Returns:

the new NlsMessage instance.

create

NlsMessage create(String internationalizedMessage)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

internationalizedMessage - is the internationalized message.

Returns:

the new NlsMessage instance.

create

NlsMessage create(NlsTemplate template)

This method creates a new instance of NlsMessage from the given arguments.

Parameters:

template - is the NlsTemplate for the raw message.

Returns:

the new NlsMessage instance.

See Also:

create(NlsTemplate, Map)