Apache Log4j API 2.22.0 · org.apache.logging.log4j.message.FormattedMessage

Modifier and Type	Field and Description
private transient Object[]	argArray
private transient String	formattedMessage
private static final int	HASHVAL
private final Locale	locale
private Message	message
private String	messagePattern
private static final long	serialVersionUID
private String[]	stringArgs
private final Throwable	throwable

Access	Constructor and Description
public	FormattedMessage(final Locale The locale locale, final String The message pattern. messagePattern, final Object The parameter. arg) Constructs with a locale, a pattern and a single parameter.
public	FormattedMessage(final Locale The locale locale, final String The message pattern. messagePattern, final Object The first parameter. arg1, final Object The second parameter. arg2) Constructs with a locale, a pattern and two parameters.
public	FormattedMessage(final Locale The locale locale, final String The message pattern. messagePattern, final Object... The parameter. arguments) Constructs with a locale, a pattern and a parameter array.
public	FormattedMessage(final Locale The Locale locale, final String The message pattern. messagePattern, final Object[] The parameter. arguments, final Throwable The throwable throwable) Constructs with a locale, a pattern, a parameter array, and a throwable.
public	FormattedMessage(final String The message pattern. messagePattern, final Object The parameter. arg) Constructs with a pattern and a single parameter.
public	FormattedMessage(final String The message pattern. messagePattern, final Object The first parameter. arg1, final Object The second parameter. arg2) Constructs with a pattern and two parameters.
public	FormattedMessage(final String The message pattern. messagePattern, final Object... The parameter. arguments) Constructs with a pattern and a parameter array.
public	FormattedMessage(final String The message pattern. messagePattern, final Object[] The parameter. arguments, final Throwable The throwable throwable) Constructs with a pattern, a parameter array, and a throwable.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the message pattern. getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Gets the message pattern.
public String	Returns: the formatted message. getFormattedMessage() Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Gets the formatted message.
protected Message	Returns: The message that performs formatting. getMessage(final String The message pattern. msgPattern, final Object[] The parameters. args, final Throwable The throwable aThrowable) Gets the message implementation to which formatting is delegated.
public Object[]	Returns: the message parameters. getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Gets the message parameters.
public Throwable	getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Gets the throwable, if any.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	readObject(final ObjectInputStream in)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	writeObject(final ObjectOutputStream out)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

argArray	back to summary
private transient Object[] argArray

formattedMessage	back to summary
private transient String formattedMessage

HASHVAL	back to summary
private static final int HASHVAL

locale	back to summary
private final Locale locale

message	back to summary
private Message message

messagePattern	back to summary
private String messagePattern

serialVersionUID	back to summary
private static final long serialVersionUID

stringArgs	back to summary
private String[] stringArgs

throwable	back to summary
private final Throwable throwable

Constructor Detail

FormattedMessage	back to summary
public FormattedMessage(final Locale locale, final String messagePattern, final Object arg) Constructs with a locale, a pattern and a single parameter. Parameters locale:Locale The locale messagePattern:String The message pattern. arg:Object The parameter. Since 2.6

FormattedMessage

back to summary

public FormattedMessage(final Locale locale, final String messagePattern, final Object arg)

Constructs with a locale, a pattern and a single parameter.

Parameters

locale:Locale: The locale
messagePattern:String: The message pattern.
arg:Object: The parameter.

Since

2.6

FormattedMessage	back to summary
public FormattedMessage(final Locale locale, final String messagePattern, final Object arg1, final Object arg2) Constructs with a locale, a pattern and two parameters. Parameters locale:Locale The locale messagePattern:String The message pattern. arg1:Object The first parameter. arg2:Object The second parameter. Since 2.6

FormattedMessage

back to summary

public FormattedMessage(final Locale locale, final String messagePattern, final Object arg1, final Object arg2)

Constructs with a locale, a pattern and two parameters.

Parameters

locale:Locale: The locale
messagePattern:String: The message pattern.
arg1:Object: The first parameter.
arg2:Object: The second parameter.

Since

2.6

FormattedMessage	back to summary
public FormattedMessage(final Locale locale, final String messagePattern, final Object... arguments) Constructs with a locale, a pattern and a parameter array. Parameters locale:Locale The locale messagePattern:String The message pattern. arguments:Object[] The parameter. Since 2.6

FormattedMessage

back to summary

public FormattedMessage(final Locale locale, final String messagePattern, final Object... arguments)

Constructs with a locale, a pattern and a parameter array.

Parameters

locale:Locale: The locale
messagePattern:String: The message pattern.
arguments:Object[]: The parameter.

Since

2.6

FormattedMessage	back to summary
public FormattedMessage(final Locale locale, final String messagePattern, final Object[] arguments, final Throwable throwable) Constructs with a locale, a pattern, a parameter array, and a throwable. Parameters locale:Locale The Locale messagePattern:String The message pattern. arguments:Object[] The parameter. throwable:Throwable The throwable Since 2.6

FormattedMessage

back to summary

public FormattedMessage(final Locale locale, final String messagePattern, final Object[] arguments, final Throwable throwable)

Constructs with a locale, a pattern, a parameter array, and a throwable.

Parameters

locale:Locale: The Locale
messagePattern:String: The message pattern.
arguments:Object[]: The parameter.
throwable:Throwable: The throwable

Since

2.6

FormattedMessage	back to summary
public FormattedMessage(final String messagePattern, final Object arg) Constructs with a pattern and a single parameter. Parameters messagePattern:String The message pattern. arg:Object The parameter.

FormattedMessage

back to summary

public FormattedMessage(final String messagePattern, final Object arg)

Constructs with a pattern and a single parameter.

Parameters

messagePattern:String: The message pattern.
arg:Object: The parameter.

FormattedMessage	back to summary
public FormattedMessage(final String messagePattern, final Object arg1, final Object arg2) Constructs with a pattern and two parameters. Parameters messagePattern:String The message pattern. arg1:Object The first parameter. arg2:Object The second parameter.

FormattedMessage

back to summary

public FormattedMessage(final String messagePattern, final Object arg1, final Object arg2)

Constructs with a pattern and two parameters.

Parameters

messagePattern:String: The message pattern.
arg1:Object: The first parameter.
arg2:Object: The second parameter.

FormattedMessage	back to summary
public FormattedMessage(final String messagePattern, final Object... arguments) Constructs with a pattern and a parameter array. Parameters messagePattern:String The message pattern. arguments:Object[] The parameter.

FormattedMessage

back to summary

public FormattedMessage(final String messagePattern, final Object... arguments)

Constructs with a pattern and a parameter array.

Parameters

messagePattern:String: The message pattern.
arguments:Object[]: The parameter.

FormattedMessage	back to summary
public FormattedMessage(final String messagePattern, final Object[] arguments, final Throwable throwable) Constructs with a pattern, a parameter array, and a throwable. Parameters messagePattern:String The message pattern. arguments:Object[] The parameter. throwable:Throwable The throwable

FormattedMessage

back to summary

public FormattedMessage(final String messagePattern, final Object[] arguments, final Throwable throwable)

Constructs with a pattern, a parameter array, and a throwable.

Parameters

messagePattern:String: The message pattern.
arguments:Object[]: The parameter.
throwable:Throwable: The throwable

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getFormat	back to summary
public String getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Gets the message pattern. Returns:String the message pattern. Annotations @Override

getFormat

back to summary

public String getFormat()

Implements org.apache.logging.log4j.message.Message.getFormat.

Gets the message pattern.

Returns:String

the message pattern.

Annotations

@Override

getFormattedMessage	back to summary
public String getFormattedMessage() Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Gets the formatted message. Returns:String the formatted message. Annotations @Override

getFormattedMessage

back to summary

public String getFormattedMessage()

Implements org.apache.logging.log4j.message.Message.getFormattedMessage.

Gets the formatted message.

Returns:String

the formatted message.

Annotations

@Override

getMessage back to summary

getMessage	back to summary
protected Message getMessage(final String msgPattern, final Object[] args, final Throwable aThrowable) Gets the message implementation to which formatting is delegated. if `msgPattern` contains `MessageFormat` format specifiers a `MessageFormatMessage` is returned, if `msgPattern` contains `{}` placeholders a `ParameterizedMessage` is returned, if `msgPattern` contains `Format` specifiers a `StringFormattedMessage` is returned . Mixing specifiers from multiple types is not supported. Parameters msgPattern:String The message pattern. args:Object[] The parameters. aThrowable:Throwable The throwable Returns:Message The message that performs formatting.

protected Message getMessage(final String msgPattern, final Object[] args, final Throwable aThrowable)

Gets the message implementation to which formatting is delegated.

if msgPattern contains MessageFormat format specifiers a MessageFormatMessage is returned,
if msgPattern contains {} placeholders a ParameterizedMessage is returned,
if msgPattern contains Format specifiers a StringFormattedMessage is returned .

Mixing specifiers from multiple types is not supported.

Parameters

msgPattern:String: The message pattern.
args:Object[]: The parameters.
aThrowable:Throwable: The throwable

Returns:Message

The message that performs formatting.

getParameters	back to summary
public Object[] getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Gets the message parameters. Returns:Object[] the message parameters. Annotations @Override

getParameters

back to summary

public Object[] getParameters()

Implements org.apache.logging.log4j.message.Message.getParameters.

Gets the message parameters.

Returns:Object[]

the message parameters.

Annotations

@Override

getThrowable	back to summary
public Throwable getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Doc from org.apache.logging.log4j.message.Message.getThrowable. Gets the throwable, if any. Returns:Throwable the throwable or null. Annotations @Override

getThrowable

back to summary

public Throwable getThrowable()

Implements org.apache.logging.log4j.message.Message.getThrowable.

Doc from org.apache.logging.log4j.message.Message.getThrowable.

Gets the throwable, if any.

Returns:Throwable

the throwable or null.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

readObject	back to summary
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

writeObject	back to summary
private void writeObject(final ObjectOutputStream out) throws IOException

public Class FormattedMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail