Top Description Fields Constructors Methods
org.apache.logging.log4j.message

public final Class ObjectArrayMessage

extends Object
implements Message
Class Inheritance
All Implemented Interfaces
org.apache.logging.log4j.message.Message, java.io.Serializable
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, java.util.Arrays, org.apache.logging.log4j.util.Constants

Handles messages that contain an Object[].

Created for use with the CSV layout. For example:

logger.debug(new ObjectArrayMessage(1, 2, "Bob"));

Since
2.4

Field Summary

Modifier and TypeField and Description
private transient Object[]
private transient String
private static final long

Constructor Summary

AccessConstructor and Description
public
ObjectArrayMessage(final Object...
The Object to format.
obj
)

Creates the ObjectMessage.

Method Summary

Modifier and TypeMethod and Description
private boolean
equalObjectsOrStrings(final Object[] left, final Object[] right)

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 String representation of the object.
getFormat
()

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

Returns the object formatted using its toString method.

public String

Returns:

the formatted object message.
getFormattedMessage
()

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

Returns the formatted object message.

public Object[]

Returns:

The object.
getParameters
()

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

Returns the object as if it were a parameter.

public Throwable
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

private void
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

arrayback to summary
private transient Object[] array
arrayStringback to summary
private transient String arrayString
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

ObjectArrayMessageback to summary
public ObjectArrayMessage(final Object... obj)

Creates the ObjectMessage.

Parameters
obj:Object[]

The Object to format.

Method Detail

equalObjectsOrStringsback to summary
private boolean equalObjectsOrStrings(final Object[] left, final Object[] right)
equalsback 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
getFormatback to summary
public String getFormat()

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

Returns the object formatted using its toString method.

Returns:String

the String representation of the object.

Annotations
@Override
getFormattedMessageback to summary
public String getFormattedMessage()

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

Returns the formatted object message.

Returns:String

the formatted object message.

Annotations
@Override
getParametersback to summary
public Object[] getParameters()

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

Returns the object as if it were a parameter.

Returns:Object[]

The object.

Annotations
@Override
getThrowableback to summary
public Throwable getThrowable()

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

Returns null.

Returns:Throwable

null.

Annotations
@Override
hashCodeback 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
readObjectback to summary
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
toStringback 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
writeObjectback to summary
private void writeObject(final ObjectOutputStream out) throws IOException