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

Field Summary

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

Constructor Summary

Access	Constructor and Description
public	StringFormattedMessage(final Locale the locale for this message format locale, final String the pattern for this message format messagePattern, final Object... The objects to format arguments) Constructs a message.
public	StringFormattedMessage(final String the pattern for this message format messagePattern, final Object... The objects to format arguments) Constructs a message.

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.
protected String	formatMessage(final String msgPattern, final Object... args)
public String	Returns: the message pattern. getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Returns the message pattern.
public String	Returns: the formatted message. getFormattedMessage() Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Returns the formatted message.
public Object[]	Returns: the message parameters. getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Returns the message parameters.
public Throwable	Returns: the Throwable. getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Return the throwable passed to the Message.
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

LOGGER	back to summary
private static final Logger LOGGER

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 transient Throwable throwable

Constructor Detail

StringFormattedMessage	back to summary
public StringFormattedMessage(final Locale locale, final String messagePattern, final Object... arguments) Constructs a message. Parameters locale:Locale the locale for this message format messagePattern:String the pattern for this message format arguments:Object[] The objects to format Since 2.6

StringFormattedMessage

back to summary

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

Constructs a message.

Parameters

locale:Locale: the locale for this message format
messagePattern:String: the pattern for this message format
arguments:Object[]: The objects to format

Since

2.6

StringFormattedMessage	back to summary
public StringFormattedMessage(final String messagePattern, final Object... arguments) Constructs a message. Parameters messagePattern:String the pattern for this message format arguments:Object[] The objects to format Since 2.6

StringFormattedMessage

back to summary

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

Constructs a message.

Parameters

messagePattern:String: the pattern for this message format
arguments:Object[]: The objects to format

Since

2.6

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

formatMessage	back to summary
protected String formatMessage(final String msgPattern, final Object... args)

getFormat	back to summary
public String getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Returns 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.

Returns 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. Returns 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.

Returns the formatted message.

Returns:String

the formatted message.

Annotations

@Override

getParameters	back to summary
public Object[] getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Returns 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.

Returns 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. Return the throwable passed to the Message. Returns:Throwable the Throwable. Annotations @Override

getThrowable

back to summary

public Throwable getThrowable()

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

Return the throwable passed to the Message.

Returns:Throwable

the Throwable.

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 StringFormattedMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail