org.apache.logging.log4j.message

Class LocalizedMessageFactory

java.lang.Object

org.apache.logging.log4j.message.AbstractMessageFactory

org.apache.logging.log4j.message.LocalizedMessageFactory

All Implemented Interfaces:

java.io.Serializable, MessageFactory, MessageFactory2

public class LocalizedMessageFactory
extends AbstractMessageFactory

Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)

Note to implementors

This class does not implement any MessageFactory2 methods and lets the superclass funnel those calls through newMessage(String, Object...).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	baseName
private java.util.ResourceBundle	resourceBundle
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
LocalizedMessageFactory(java.util.ResourceBundle resourceBundle)
LocalizedMessageFactory(java.lang.String baseName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseName() Gets the resource bundle base name if set.
java.util.ResourceBundle	getResourceBundle() Gets the resource bundle if set.
Message	newMessage(java.lang.String key) Creates a new message based on a String.
Message	newMessage(java.lang.String key, java.lang.Object... params) Creates LocalizedMessage instances.

Methods inherited from class org.apache.logging.log4j.message.AbstractMessageFactory

newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage, newMessage

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

resourceBundle

private final transient java.util.ResourceBundle resourceBundle

baseName

private final java.lang.String baseName

Constructor Detail

LocalizedMessageFactory

public LocalizedMessageFactory(java.util.ResourceBundle resourceBundle)

LocalizedMessageFactory

public LocalizedMessageFactory(java.lang.String baseName)

Method Detail

getBaseName

public java.lang.String getBaseName()

Gets the resource bundle base name if set.

Returns:

the resource bundle base name if set. May be null.

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Gets the resource bundle if set.

Returns:

the resource bundle if set. May be null.

newMessage

public Message newMessage(java.lang.String key)

Description copied from interface: MessageFactory

Creates a new message based on a String.

Specified by:

newMessage in interface MessageFactory

Overrides:

newMessage in class AbstractMessageFactory

Parameters:

key - a message String

Returns:

a new message

Since:

2.8

newMessage

public Message newMessage(java.lang.String key,
                          java.lang.Object... params)

Creates LocalizedMessage instances.

Parameters:

key - The key String, used as a message if the key is absent.

params - The parameters for the message at the given key.

Returns:

The LocalizedMessage.

See Also:

MessageFactory.newMessage(String, Object...)