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

Modifier and Type	Class and Description
public static enum	MapMessage.MapFormat When set as the format specifier causes the Map to be formatted as XML.

Modifier and Type	Field and Description
private final IndexedStringMap	data
private static final long	serialVersionUID

Access	Constructor and Description
public	MapMessage() Constructs a new instance.
public	MapMessage(final int the initial capacity. initialCapacity) Constructs a new instance.
public	MapMessage(final Map<String, V> The Map. map) Constructs a new instance based on an existing `Map`.

Method Summary

Modifier and Type	Method and Description
protected void	appendMap(final StringBuilder sb)
protected void	asJava(final StringBuilder sb)
private void	asJava(final StringBuilder sb, final boolean quoted)
protected void	asJavaUnquoted(final StringBuilder sb)
protected void	asJson(final StringBuilder sb)
public String	Returns: The formatted String. asString() Formats the Structured data as described in RFC 5424.
public String	Returns: The formatted String. asString(final String The format identifier. format) Formats the Structured data as described in RFC 5424.
public void	asXml(final StringBuilder format into this builder. sb) Formats this message as an XML fragment String into the given builder.
public void	clear() Clear the data.
public boolean	Returns: `true` if this data structure contains the specified key, `false` otherwise containsKey(final String the key whose presence to check. May be `null`. key) Returns `true` if this data structure contains the specified key, `false` otherwise.
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 < type of the consumer value CV> void	forEach(final BiConsumer<String, ? super CV> The action to be performed for each key-value pair in this collection action) Performs the given action for each key-value pair in this data structure until all entries have been processed or the action throws an exception.
public < type of the consumer value CV, type of the third parameter S> void	forEach(final TriConsumer<String, ? super CV, S> The action to be performed for each key-value pair in this collection action, final S the object to be passed as the third parameter to each invocation on the specified triconsumer state) Performs the given action for each key-value pair in this data structure until all entries have been processed or the action throws an exception.
private StringBuilder	Returns: The formatted String. format(final MapMessage.MapFormat The format identifier. format, final StringBuilder sb) Formats the Structured data as described in RFC 5424.
public void	formatTo(final StringBuilder the StringBuilder to write into buffer) Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects.
public void	formatTo(final String[] An array of Strings that provide extra information about how to format the message. Each MultiFormatStringBuilderFormattable implementation is free to use the provided formats however they choose. formats, final StringBuilder the StringBuilder to write into buffer) Implements org.apache.logging.log4j.util.MultiFormatStringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects.
public String	Returns: The value of the element or null if the key is not present. get(final String The name of the element. key) Retrieves the value of the element with the specified key or null if the key is not present.
public Map<String, V>	Returns: the message data as an unmodifiable map. getData() Returns the message data as an unmodifiable Map.
public String	Returns: the message. getFormat() Implements org.apache.logging.log4j.message.Message.getFormat. Returns the message.
private MapMessage.MapFormat	getFormat(final String[] formats)
public String[]	getFormats() Implements org.apache.logging.log4j.message.MultiformatMessage.getFormats. Returns the supported formats.
public String	Returns: the formatted message. getFormattedMessage() Implements org.apache.logging.log4j.message.Message.getFormattedMessage. Formats the message and return it.
public String	Returns: The formatted message. getFormattedMessage(final String[] An array of Strings that provide extra information about how to format the message. MapMessage uses the first format specifier it recognizes. The supported formats are XML, JSON, and JAVA. The default format is key1="value1" key2="value2" as required by RFC 5424 messages. formats) Implements org.apache.logging.log4j.message.MultiformatMessage.getFormattedMessage. Returns the Message formatted as a String.
public IndexedReadOnlyStringMap	Returns: the read-only message data. getIndexedReadOnlyStringMap() Returns a read-only view of the message data.
public Object[]	Returns: the data elements. getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Returns the data elements as if they were parameters on the logging event.
public Throwable	Returns: null getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Always returns null.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public M	Returns: A new MapMessage newInstance(final Map<String, V> The Map. map) Constructs a new instance based on an existing Map.
public void	put(final String The name of the data item. candidateKey, final String The value of the data item. value) Adds an item to the data Map.
public void	putAll(final Map<String, String> The Map to add. map) Adds all the elements from the specified Map.
public String	Returns: The previous value of the element. remove(final String The name of the element. key) Removes the element with the specified name.
protected String	Returns: The candidate key. toKey(final String The candidate key. candidateKey) Allows subclasses to change a candidate key to an actual key.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	validate(final String key, final boolean value) Default implementation does nothing.
protected void	validate(final String key, final byte value) Default implementation does nothing.
protected void	validate(final String key, final char value) Default implementation does nothing.
protected void	validate(final String key, final double value) Default implementation does nothing.
protected void	validate(final String key, final float value) Default implementation does nothing.
protected void	validate(final String key, final int value) Default implementation does nothing.
protected void	validate(final String key, final long value) Default implementation does nothing.
protected void	validate(final String key, final Object value) Default implementation does nothing.
protected void	validate(final String key, final short value) Default implementation does nothing.
protected void	validate(final String key, final String value) Default implementation does nothing.
public M	Returns: this object with(final String The name of the data item. candidateKey, final boolean The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final byte The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final char The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final double The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final float The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final int The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final long The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final Object The value of the data item. value) Adds an item to the data Map.
public M	Returns: this object with(final String The name of the data item. candidateKey, final short The value of the data item. value) Adds an item to the data Map.
public M	Returns: `this` with(final String The name of the data item. candidateKey, final String The value of the data item. value) Adds an item to the data Map in fluent style.

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

data	back to summary
private final IndexedStringMap data

serialVersionUID	back to summary
private static final long serialVersionUID

MapMessage	back to summary
public MapMessage() Constructs a new instance.

MapMessage	back to summary
public MapMessage(final int initialCapacity) Constructs a new instance. Parameters initialCapacity:int the initial capacity.

MapMessage	back to summary
public MapMessage(final Map<String, V> map) Constructs a new instance based on an existing `Map`. Parameters map:Map<String, V> The Map.

Method Detail

appendMap	back to summary
protected void appendMap(final StringBuilder sb)

asJava	back to summary
protected void asJava(final StringBuilder sb)

asJava	back to summary
private void asJava(final StringBuilder sb, final boolean quoted)

asJavaUnquoted	back to summary
protected void asJavaUnquoted(final StringBuilder sb)

asJson	back to summary
protected void asJson(final StringBuilder sb)

asString	back to summary
public String asString() Formats the Structured data as described in RFC 5424. Returns:String The formatted String.

asString

back to summary

public String asString()

Formats the Structured data as described in RFC 5424.

Returns:String: The formatted String.

asString	back to summary
public String asString(final String format) Formats the Structured data as described in RFC 5424. Parameters format:String The format identifier. Returns:String The formatted String.

asString

back to summary

public String asString(final String format)

Formats the Structured data as described in RFC 5424.

Parameters

format:String: The format identifier.

Returns:String

The formatted String.

asXml	back to summary
public void asXml(final StringBuilder sb) Formats this message as an XML fragment String into the given builder. Parameters sb:StringBuilder format into this builder.

asXml

back to summary

public void asXml(final StringBuilder sb)

Formats this message as an XML fragment String into the given builder.

Parameters

sb:StringBuilder: format into this builder.

clear	back to summary
public void clear() Clear the data.

containsKey back to summary

containsKey	back to summary
public boolean containsKey(final String key) Returns `true` if this data structure contains the specified key, `false` otherwise. Parameters key:String the key whose presence to check. May be `null`. Returns:boolean `true` if this data structure contains the specified key, `false` otherwise Since 2.9

public boolean containsKey(final String key)

Returns true if this data structure contains the specified key, false otherwise.

Parameters

key:String: the key whose presence to check. May be null.

Returns:boolean

true if this data structure contains the specified key, false otherwise

Since

2.9

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

forEach back to summary

forEach	back to summary
public <CV> void forEach(final BiConsumer<String, ? super CV> action) Performs the given action for each key-value pair in this data structure until all entries have been processed or the action throws an exception. Some implementations may not support structural modifications (adding new elements or removing elements) while iterating over the contents. In such implementations, attempts to add or remove elements from the `BiConsumer`'s `BiConsumer#accept(Object, Object)` accept} method may cause a `ConcurrentModificationException` to be thrown. Parameters <CV> type of the consumer value action:BiConsumer<String, ? super CV> The action to be performed for each key-value pair in this collection Exceptions ConcurrentModificationException: some implementations may not support structural modifications to this data structure while iterating over the contents with `forEach(BiConsumer)` or `forEach(TriConsumer, Object)`. Since 2.9 See Also `ReadOnlyStringMap#forEach(BiConsumer)`

public <CV> void forEach(final BiConsumer<String, ? super CV> action)

Performs the given action for each key-value pair in this data structure until all entries have been processed or the action throws an exception.

Some implementations may not support structural modifications (adding new elements or removing elements) while iterating over the contents. In such implementations, attempts to add or remove elements from the BiConsumer's BiConsumer#accept(Object, Object) accept} method may cause a ConcurrentModificationException to be thrown.

Parameters

<CV>: type of the consumer value
action:BiConsumer<String, ? super CV>: The action to be performed for each key-value pair in this collection

Exceptions

ConcurrentModificationException:: some implementations may not support structural modifications to this data structure while iterating over the contents with forEach(BiConsumer) or forEach(TriConsumer, Object).

Since

2.9

See Also

ReadOnlyStringMap#forEach(BiConsumer)

forEach back to summary

forEach	back to summary
public <CV, S> void forEach(final TriConsumer<String, ? super CV, S> action, final S state) Performs the given action for each key-value pair in this data structure until all entries have been processed or the action throws an exception. The third parameter lets callers pass in a stateful object to be modified with the key-value pairs, so the TriConsumer implementation itself can be stateless and potentially reusable. Some implementations may not support structural modifications (adding new elements or removing elements) while iterating over the contents. In such implementations, attempts to add or remove elements from the `TriConsumer`'s `accept` method may cause a `ConcurrentModificationException` to be thrown. Parameters <CV> type of the consumer value <S> type of the third parameter action:TriConsumer<String, ? super CV, S> The action to be performed for each key-value pair in this collection state:S the object to be passed as the third parameter to each invocation on the specified triconsumer Exceptions ConcurrentModificationException: some implementations may not support structural modifications to this data structure while iterating over the contents with `forEach(BiConsumer)` or `forEach(TriConsumer, Object)`. Since 2.9 See Also `ReadOnlyStringMap#forEach(TriConsumer, Object)`

public <CV, S> void forEach(final TriConsumer<String, ? super CV, S> action, final S state)

Performs the given action for each key-value pair in this data structure until all entries have been processed or the action throws an exception.

The third parameter lets callers pass in a stateful object to be modified with the key-value pairs, so the TriConsumer implementation itself can be stateless and potentially reusable.

Some implementations may not support structural modifications (adding new elements or removing elements) while iterating over the contents. In such implementations, attempts to add or remove elements from the TriConsumer's accept method may cause a ConcurrentModificationException to be thrown.

Parameters

<CV>: type of the consumer value
<S>: type of the third parameter
action:TriConsumer<String, ? super CV, S>: The action to be performed for each key-value pair in this collection
state:S: the object to be passed as the third parameter to each invocation on the specified triconsumer

Exceptions

ConcurrentModificationException:: some implementations may not support structural modifications to this data structure while iterating over the contents with forEach(BiConsumer) or forEach(TriConsumer, Object).

Since

2.9

format	back to summary
private StringBuilder format(final MapMessage.MapFormat format, final StringBuilder sb) Formats the Structured data as described in RFC 5424. Parameters format:MapMessage.MapFormat The format identifier. Returns:StringBuilder The formatted String.

format

back to summary

private StringBuilder format(final MapMessage.MapFormat format, final StringBuilder sb)

Formats the Structured data as described in RFC 5424.

Parameters

format:MapMessage.MapFormat: The format identifier.

Returns:StringBuilder

The formatted String.

formatTo back to summary

formatTo	back to summary
public void formatTo(final StringBuilder buffer) Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects. Parameters buffer:StringBuilder the StringBuilder to write into Annotations @Override

public void formatTo(final StringBuilder buffer)

Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Parameters

buffer:StringBuilder: the StringBuilder to write into

Annotations

@Override

formatTo back to summary

formatTo	back to summary
public void formatTo(final String[] formats, final StringBuilder buffer) Implements org.apache.logging.log4j.util.MultiFormatStringBuilderFormattable.formatTo. Doc from org.apache.logging.log4j.util.MultiFormatStringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects. Parameters formats:String[] An array of Strings that provide extra information about how to format the message. Each MultiFormatStringBuilderFormattable implementation is free to use the provided formats however they choose. buffer:StringBuilder the StringBuilder to write into Annotations @Override

public void formatTo(final String[] formats, final StringBuilder buffer)

Implements org.apache.logging.log4j.util.MultiFormatStringBuilderFormattable.formatTo.

Doc from org.apache.logging.log4j.util.MultiFormatStringBuilderFormattable.formatTo.

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Parameters

formats:String[]: An array of Strings that provide extra information about how to format the message. Each MultiFormatStringBuilderFormattable implementation is free to use the provided formats however they choose.
buffer:StringBuilder: the StringBuilder to write into

Annotations

@Override

get	back to summary
public String get(final String key) Retrieves the value of the element with the specified key or null if the key is not present. Parameters key:String The name of the element. Returns:String The value of the element or null if the key is not present.

get

back to summary

public String get(final String key)

Retrieves the value of the element with the specified key or null if the key is not present.

Parameters

key:String: The name of the element.

Returns:String

The value of the element or null if the key is not present.

getData	back to summary
public Map<String, V> getData() Returns the message data as an unmodifiable Map. Returns:Map<String, V> the message data as an unmodifiable map. Annotations @SuppressWarnings:unchecked

getData

back to summary

public Map<String, V> getData()

Returns the message data as an unmodifiable Map.

Returns:Map<String, V>

the message data as an unmodifiable map.

Annotations

@SuppressWarnings:unchecked

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

getFormat

back to summary

public String getFormat()

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

Returns the message.

Returns:String

the message.

Annotations

@Override

getFormat	back to summary
private MapMessage.MapFormat getFormat(final String[] formats)

getFormats	back to summary
public String[] getFormats() Implements org.apache.logging.log4j.message.MultiformatMessage.getFormats. Doc from org.apache.logging.log4j.message.MultiformatMessage.getFormats. Returns the supported formats. Returns:String[] The supported formats. Annotations @Override

getFormats

back to summary

public String[] getFormats()

Implements org.apache.logging.log4j.message.MultiformatMessage.getFormats.

Doc from org.apache.logging.log4j.message.MultiformatMessage.getFormats.

Returns the supported formats.

Returns:String[]

The supported formats.

Annotations

@Override

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

getFormattedMessage

back to summary

public String getFormattedMessage()

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

Formats the message and return it.

Returns:String

the formatted message.

Annotations

@Override

getFormattedMessage	back to summary
public String getFormattedMessage(final String[] formats) Implements org.apache.logging.log4j.message.MultiformatMessage.getFormattedMessage. Doc from org.apache.logging.log4j.message.MultiformatMessage.getFormattedMessage. Returns the Message formatted as a String. Parameters formats:String[] An array of Strings that provide extra information about how to format the message. MapMessage uses the first format specifier it recognizes. The supported formats are XML, JSON, and JAVA. The default format is key1="value1" key2="value2" as required by RFC 5424 messages. Returns:String The formatted message. Annotations @Override

getFormattedMessage

back to summary

public String getFormattedMessage(final String[] formats)

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

Doc from org.apache.logging.log4j.message.MultiformatMessage.getFormattedMessage.

Returns the Message formatted as a String.

Parameters

formats:String[]: An array of Strings that provide extra information about how to format the message. MapMessage uses the first format specifier it recognizes. The supported formats are XML, JSON, and JAVA. The default format is key1="value1" key2="value2" as required by RFC 5424 messages.

Returns:String

The formatted message.

Annotations

@Override

getIndexedReadOnlyStringMap	back to summary
public IndexedReadOnlyStringMap getIndexedReadOnlyStringMap() Returns a read-only view of the message data. Returns:IndexedReadOnlyStringMap the read-only message data.

getIndexedReadOnlyStringMap

back to summary

public IndexedReadOnlyStringMap getIndexedReadOnlyStringMap()

Returns a read-only view of the message data.

Returns:IndexedReadOnlyStringMap: the read-only message data.

getParameters	back to summary
public Object[] getParameters() Implements org.apache.logging.log4j.message.Message.getParameters. Returns the data elements as if they were parameters on the logging event. Returns:Object[] the data elements. Annotations @Override

getParameters

back to summary

public Object[] getParameters()

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

Returns the data elements as if they were parameters on the logging event.

Returns:Object[]

the data elements.

Annotations

@Override

getThrowable	back to summary
public Throwable getThrowable() Implements org.apache.logging.log4j.message.Message.getThrowable. Always returns null. Returns:Throwable null Annotations @Override

getThrowable

back to summary

public Throwable getThrowable()

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

Always returns null.

Returns:Throwable

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

newInstance	back to summary
public M newInstance(final Map<String, V> map) Constructs a new instance based on an existing Map. Parameters map:Map<String, V> The Map. Returns:M A new MapMessage Annotations @SuppressWarnings:unchecked

newInstance

back to summary

public M newInstance(final Map<String, V> map)

Constructs a new instance based on an existing Map.

Parameters

map:Map<String, V>: The Map.

Returns:M

A new MapMessage

Annotations

@SuppressWarnings:unchecked

put	back to summary
public void put(final String candidateKey, final String value) Adds an item to the data Map. Parameters candidateKey:String The name of the data item. value:String The value of the data item.

put

back to summary

public void put(final String candidateKey, final String value)

Adds an item to the data Map.

Parameters

candidateKey:String: The name of the data item.
value:String: The value of the data item.

putAll	back to summary
public void putAll(final Map<String, String> map) Adds all the elements from the specified Map. Parameters map:Map<String, String> The Map to add.

putAll

back to summary

public void putAll(final Map<String, String> map)

Adds all the elements from the specified Map.

Parameters

map:Map<String, String>: The Map to add.

remove	back to summary
public String remove(final String key) Removes the element with the specified name. Parameters key:String The name of the element. Returns:String The previous value of the element.

remove

back to summary

public String remove(final String key)

Removes the element with the specified name.

Parameters

key:String: The name of the element.

Returns:String

The previous value of the element.

toKey	back to summary
protected String toKey(final String candidateKey) Allows subclasses to change a candidate key to an actual key. Parameters candidateKey:String The candidate key. Returns:String The candidate key. Since 2.12

toKey

back to summary

protected String toKey(final String candidateKey)

Allows subclasses to change a candidate key to an actual key.

Parameters

candidateKey:String: The candidate key.

Returns:String

The candidate key.

Since

2.12

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

validate	back to summary
protected void validate(final String key, final boolean value) Default implementation does nothing. Since 2.9

validate

back to summary

protected void validate(final String key, final boolean value)