Modifier and Type	Class and Description
pack-priv static class	ParameterFormatter.MessagePatternAnalysis See `analyzePattern(String, int, MessagePatternAnalysis)`.

Modifier and Type	Field and Description
private static final DateTimeFormatter	DATE_FORMATTER
private static final char	DELIM_START
private static final char	DELIM_STOP
pack-priv static final String	ERROR_MSG_SEPARATOR Separator for error messages.
pack-priv static final String	ERROR_PREFIX Prefix for errors.
pack-priv static final String	ERROR_SEPARATOR Separator for errors.
pack-priv static final String	ERROR_SUFFIX Suffix for errors.
private static final char	ESCAPE_CHAR
pack-priv static final String	RECURSION_PREFIX Prefix for recursion.
pack-priv static final String	RECURSION_SUFFIX Suffix for recursion.

Access	Constructor and Description
private	ParameterFormatter()

Method Summary

Modifier and Type	Method and Description
pack-priv static ParameterFormatter.MessagePatternAnalysis	Returns: the analysis result analyzePattern(final String a message pattern to be analyzed pattern, final int The number of arguments to be formatted. For instance, for a parametrized message containing 7 placeholders in the pattern and 4 arguments for formatting, analysis will only need to store the index of the first 4 placeholder characters. A negative value indicates no limit. argCount) Analyzes – finds argument placeholder (i.e., "{}") occurrences, etc. – the given message pattern.
pack-priv static void	analyzePattern(final String a message pattern to be analyzed pattern, final int The number of arguments to be formatted. For instance, for a parametrized message containing 7 placeholders in the pattern and 4 arguments for formatting, analysis will only need to store the index of the first 4 placeholder characters. A negative value indicates no limit. argCount, final ParameterFormatter.MessagePatternAnalysis an object to store the results analysis) Analyzes – finds argument placeholder (i.e., "{}") occurrences, etc. – the given message pattern.
private static void	appendArray(final Object o, final StringBuilder str, final Set<Object> dejaVu, final Class<?> oClass)
private static void	appendCollection(final Object o, final StringBuilder str, final Set<Object> dejaVu) Specialized handler for `Collection`s.
private static boolean	appendDate(final Object o, final StringBuilder str)
private static void	appendMap(final Object o, final StringBuilder str, final Set<Object> dejaVu) Specialized handler for `Map`s.
private static void	appendPotentiallyRecursiveValue(final Object o, final StringBuilder str, final Set<Object> dejaVu)
private static boolean	appendSpecialTypes(final Object o, final StringBuilder str)
private static Set<Object>	cloneDejaVu(final Set<Object> dejaVu)
private static void	copyMessagePatternContainingEscapes(final StringBuilder buffer, final String pattern, final int startIndex, final int endIndex)
private static Set<Object>	createDejaVu()
pack-priv static String	Returns: The String representation. deepToString(final Object The object. o) This method performs a deep toString of the given Object.
pack-priv static String	Returns: the formatted message format(final String a formatting pattern pattern, final Object[] arguments to be formatted args, int argCount) Format the following pattern using provided arguments.
pack-priv static void	formatMessage(final StringBuilder buffer, final String pattern, final Object[] args, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)
pack-priv static void	formatMessageContainingEscapes(final StringBuilder buffer, final String pattern, final Object[] args, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)
pack-priv static void	formatMessageContainingNoEscapes(final StringBuilder buffer, final String pattern, final Object[] args, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)
private static Set<Object>	getOrCreateDejaVu(final Set<Object> dejaVu)
private static void	handleErrorInObjectToString(final Object o, final StringBuilder str, final Throwable t)
pack-priv static String	Returns: the identity string as also defined in Object.toString() identityToString(final Object the Object that is to be converted into an identity string. obj) This method returns the same as if Object.toString() would not have been overridden in obj.
private static boolean	isMaybeRecursive(final Object o) Returns `true` if the specified object is an array, a Map or a Collection.
pack-priv static void	recursiveDeepToString(final Object the `Object` to convert into a `String` o, final StringBuilder the `StringBuilder` that `o` will be appended to str) This method performs a deep `toString()` of the given `Object`.
private static void	recursiveDeepToString(final Object the `Object` to convert into a `String` o, final StringBuilder the `StringBuilder` that `o` will be appended to str, final Set<Object> a set of container objects directly or transitively containing `o` dejaVu) This method performs a deep `toString()` of the given `Object`.
private static void	tryObjectToString(final Object o, final StringBuilder str)

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

Field Detail

DATE_FORMATTER	back to summary
private static final DateTimeFormatter DATE_FORMATTER

DELIM_START	back to summary
private static final char DELIM_START

DELIM_STOP	back to summary
private static final char DELIM_STOP

ERROR_MSG_SEPARATOR	back to summary
pack-priv static final String ERROR_MSG_SEPARATOR Separator for error messages.

ERROR_PREFIX	back to summary
pack-priv static final String ERROR_PREFIX Prefix for errors.

ERROR_SEPARATOR	back to summary
pack-priv static final String ERROR_SEPARATOR Separator for errors.

ERROR_SUFFIX	back to summary
pack-priv static final String ERROR_SUFFIX Suffix for errors.

ESCAPE_CHAR	back to summary
private static final char ESCAPE_CHAR

RECURSION_PREFIX	back to summary
pack-priv static final String RECURSION_PREFIX Prefix for recursion.

RECURSION_SUFFIX	back to summary
pack-priv static final String RECURSION_SUFFIX Suffix for recursion.

Constructor Detail

ParameterFormatter	back to summary
private ParameterFormatter()

Method Detail

analyzePattern	back to summary
pack-priv static ParameterFormatter.MessagePatternAnalysis analyzePattern(final String pattern, final int argCount) Analyzes – finds argument placeholder (i.e., "{}") occurrences, etc. – the given message pattern. Only "{}" strings are treated as argument placeholders. Escaped or incomplete argument placeholders will be ignored. Some invalid argument placeholder examples: { } foo\{} {bar {buzz} Parameters pattern:String a message pattern to be analyzed argCount:int The number of arguments to be formatted. For instance, for a parametrized message containing 7 placeholders in the pattern and 4 arguments for formatting, analysis will only need to store the index of the first 4 placeholder characters. A negative value indicates no limit. Returns:ParameterFormatter.MessagePatternAnalysis the analysis result

analyzePattern

back to summary

pack-priv static ParameterFormatter.MessagePatternAnalysis analyzePattern(final String pattern, final int argCount)

Analyzes – finds argument placeholder (i.e., "{}") occurrences, etc. – the given message pattern.

Only "{}" strings are treated as argument placeholders. Escaped or incomplete argument placeholders will be ignored. Some invalid argument placeholder examples:

{ }
foo\{}
{bar
{buzz}

Parameters

pattern:String: a message pattern to be analyzed
argCount:int: The number of arguments to be formatted. For instance, for a parametrized message containing 7 placeholders in the pattern and 4 arguments for formatting, analysis will only need to store the index of the first 4 placeholder characters. A negative value indicates no limit.

Returns:ParameterFormatter.MessagePatternAnalysis

the analysis result

analyzePattern	back to summary
pack-priv static void analyzePattern(final String pattern, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis) Analyzes – finds argument placeholder (i.e., "{}") occurrences, etc. – the given message pattern. Only "{}" strings are treated as argument placeholders. Escaped or incomplete argument placeholders will be ignored. Some invalid argument placeholder examples: { } foo\{} {bar {buzz} Parameters pattern:String a message pattern to be analyzed argCount:int The number of arguments to be formatted. For instance, for a parametrized message containing 7 placeholders in the pattern and 4 arguments for formatting, analysis will only need to store the index of the first 4 placeholder characters. A negative value indicates no limit. analysis:ParameterFormatter.MessagePatternAnalysis an object to store the results

analyzePattern

back to summary

pack-priv static void analyzePattern(final String pattern, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)

Analyzes – finds argument placeholder (i.e., "{}") occurrences, etc. – the given message pattern.

Only "{}" strings are treated as argument placeholders. Escaped or incomplete argument placeholders will be ignored. Some invalid argument placeholder examples:

{ }
foo\{}
{bar
{buzz}

Parameters

pattern:String: a message pattern to be analyzed
argCount:int: The number of arguments to be formatted. For instance, for a parametrized message containing 7 placeholders in the pattern and 4 arguments for formatting, analysis will only need to store the index of the first 4 placeholder characters. A negative value indicates no limit.
analysis:ParameterFormatter.MessagePatternAnalysis: an object to store the results

appendArray	back to summary
private static void appendArray(final Object o, final StringBuilder str, final Set<Object> dejaVu, final Class<?> oClass)

appendCollection	back to summary
private static void appendCollection(final Object o, final StringBuilder str, final Set<Object> dejaVu) Specialized handler for `Collection`s.

appendDate	back to summary
private static boolean appendDate(final Object o, final StringBuilder str)

appendMap	back to summary
private static void appendMap(final Object o, final StringBuilder str, final Set<Object> dejaVu) Specialized handler for `Map`s.

appendPotentiallyRecursiveValue	back to summary
private static void appendPotentiallyRecursiveValue(final Object o, final StringBuilder str, final Set<Object> dejaVu)

appendSpecialTypes	back to summary
private static boolean appendSpecialTypes(final Object o, final StringBuilder str)

cloneDejaVu	back to summary
private static Set<Object> cloneDejaVu(final Set<Object> dejaVu)

copyMessagePatternContainingEscapes	back to summary
private static void copyMessagePatternContainingEscapes(final StringBuilder buffer, final String pattern, final int startIndex, final int endIndex)

createDejaVu	back to summary
private static Set<Object> createDejaVu()

deepToString	back to summary
pack-priv static String deepToString(final Object o) This method performs a deep toString of the given Object. Primitive arrays are converted using their respective Arrays.toString methods while special handling is implemented for "container types", i.e. Object[], Map and Collection because those could contain themselves. It should be noted that neither AbstractMap.toString() nor AbstractCollection.toString() implement such a behavior. They only check if the container is directly contained in itself, but not if a contained container contains the original one. Because of that, Arrays.toString(Object[]) isn't safe either. Confusing? Just read the last paragraph again and check the respective toString() implementation. This means, in effect, that logging would produce a usable output even if an ordinary System.out.println(o) would produce a relatively hard-to-debug StackOverflowError. Parameters o:Object The object. Returns:String The String representation.

deepToString

back to summary

pack-priv static String deepToString(final Object o)

This method performs a deep toString of the given Object. Primitive arrays are converted using their respective Arrays.toString methods while special handling is implemented for "container types", i.e. Object[], Map and Collection because those could contain themselves.

It should be noted that neither AbstractMap.toString() nor AbstractCollection.toString() implement such a behavior. They only check if the container is directly contained in itself, but not if a contained container contains the original one. Because of that, Arrays.toString(Object[]) isn't safe either. Confusing? Just read the last paragraph again and check the respective toString() implementation.

This means, in effect, that logging would produce a usable output even if an ordinary System.out.println(o) would produce a relatively hard-to-debug StackOverflowError.

Parameters

o:Object: The object.

Returns:String

The String representation.

format	back to summary
pack-priv static String format(final String pattern, final Object[] args, int argCount) Format the following pattern using provided arguments. Parameters pattern:String a formatting pattern args:Object[] arguments to be formatted Returns:String the formatted message

format

back to summary

pack-priv static String format(final String pattern, final Object[] args, int argCount)

Format the following pattern using provided arguments.

Parameters

pattern:String: a formatting pattern
args:Object[]: arguments to be formatted

Returns:String

the formatted message

formatMessage	back to summary
pack-priv static void formatMessage(final StringBuilder buffer, final String pattern, final Object[] args, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)

formatMessageContainingEscapes	back to summary
pack-priv static void formatMessageContainingEscapes(final StringBuilder buffer, final String pattern, final Object[] args, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)

formatMessageContainingNoEscapes	back to summary
pack-priv static void formatMessageContainingNoEscapes(final StringBuilder buffer, final String pattern, final Object[] args, final int argCount, final ParameterFormatter.MessagePatternAnalysis analysis)

getOrCreateDejaVu	back to summary
private static Set<Object> getOrCreateDejaVu(final Set<Object> dejaVu)

handleErrorInObjectToString	back to summary
private static void handleErrorInObjectToString(final Object o, final StringBuilder str, final Throwable t)

identityToString back to summary

identityToString	back to summary
pack-priv static String identityToString(final Object obj) This method returns the same as if Object.toString() would not have been overridden in obj. Note that this isn't 100% secure as collisions can always happen with hash codes. Copied from Object.hashCode(): As much as is reasonably practical, the hashCode method defined by class `Object` does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.) Parameters obj:Object the Object that is to be converted into an identity string. Returns:String the identity string as also defined in Object.toString()

pack-priv static String identityToString(final Object obj)

This method returns the same as if Object.toString() would not have been overridden in obj.

Note that this isn't 100% secure as collisions can always happen with hash codes.

Copied from Object.hashCode():

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Parameters

obj:Object: the Object that is to be converted into an identity string.

Returns:String

the identity string as also defined in Object.toString()

isMaybeRecursive	back to summary
private static boolean isMaybeRecursive(final Object o) Returns `true` if the specified object is an array, a Map or a Collection.

recursiveDeepToString back to summary

recursiveDeepToString	back to summary
pack-priv static void recursiveDeepToString(final Object o, final StringBuilder str) This method performs a deep `toString()` of the given `Object`. Primitive arrays are converted using their respective `Arrays.toString()` methods, while special handling is implemented for container types, i.e. `Object[]`, `Map` and `Collection`, because those could contain themselves. It should be noted that neither `AbstractMap.toString()` nor `AbstractCollection.toString()` implement such a behavior. They only check if the container is directly contained in itself, but not if a contained container contains the original one. Because of that, `Arrays.toString(Object[])` isn't safe either. Confusing? Just read the last paragraph again and check the respective `toString()` implementation. This means, in effect, that logging would produce a usable output even if an ordinary `System.out.println(o)` would produce a relatively hard-to-debug `StackOverflowError`. Parameters o:Object the `Object` to convert into a `String` str:StringBuilder the `StringBuilder` that `o` will be appended to

pack-priv static void recursiveDeepToString(final Object o, final StringBuilder str)

This method performs a deep toString() of the given Object.

Primitive arrays are converted using their respective Arrays.toString() methods, while special handling is implemented for container types, i.e. Object[], Map and Collection, because those could contain themselves.

It should be noted that neither AbstractMap.toString() nor AbstractCollection.toString() implement such a behavior. They only check if the container is directly contained in itself, but not if a contained container contains the original one. Because of that, Arrays.toString(Object[]) isn't safe either. Confusing? Just read the last paragraph again and check the respective toString() implementation.

This means, in effect, that logging would produce a usable output even if an ordinary System.out.println(o) would produce a relatively hard-to-debug StackOverflowError.

Parameters

o:Object: the Object to convert into a String
str:StringBuilder: the StringBuilder that o will be appended to

recursiveDeepToString back to summary

recursiveDeepToString	back to summary
private static void recursiveDeepToString(final Object o, final StringBuilder str, final Set<Object> dejaVu) This method performs a deep `toString()` of the given `Object`. Primitive arrays are converted using their respective `Arrays.toString()` methods, while special handling is implemented for container types, i.e. `Object[]`, `Map` and `Collection`, because those could contain themselves. `dejaVu` is used in case of those container types to prevent an endless recursion. It should be noted that neither `AbstractMap.toString()` nor `AbstractCollection.toString()` implement such a behavior. They only check if the container is directly contained in itself, but not if a contained container contains the original one. Because of that, `Arrays.toString(Object[])` isn't safe either. Confusing? Just read the last paragraph again and check the respective `toString()` implementation. This means, in effect, that logging would produce a usable output even if an ordinary `System.out.println(o)` would produce a relatively hard-to-debug `StackOverflowError`. Parameters o:Object the `Object` to convert into a `String` str:StringBuilder the `StringBuilder` that `o` will be appended to dejaVu:Set<Object> a set of container objects directly or transitively containing `o`

private static void recursiveDeepToString(final Object o, final StringBuilder str, final Set<Object> dejaVu)

This method performs a deep toString() of the given Object.

dejaVu is used in case of those container types to prevent an endless recursion.

This means, in effect, that logging would produce a usable output even if an ordinary System.out.println(o) would produce a relatively hard-to-debug StackOverflowError.

Parameters

o:Object: the Object to convert into a String
str:StringBuilder: the StringBuilder that o will be appended to
dejaVu:Set<Object>: a set of container objects directly or transitively containing o

tryObjectToString	back to summary
private static void tryObjectToString(final Object o, final StringBuilder str)

org.apache.logging.log4j.message back to summary

pack-priv final Class ParameterFormatter.MessagePatternAnalysis

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.apache.logging.log4j.message.ParameterFormatter.MessagePatternAnalysis

All Implemented Interfaces

java.io.Serializable

See analyzePattern(String, int, MessagePatternAnalysis).

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	escapedCharFound Flag indicating if an escaped (i.e., `\`-prefixed) character is found.
private static final int	PLACEHOLDER_CHAR_INDEX_BUFFER_INITIAL_SIZE The size of the `placeholderCharIndices` buffer to be allocated if it is found to be null.
private static final int	PLACEHOLDER_CHAR_INDEX_BUFFER_SIZE_INCREMENT The size `placeholderCharIndices` buffer will be extended with if it has found to be insufficient.
pack-priv int[]	placeholderCharIndices The array of indices pointing to the first character of the found argument placeholder occurrences.
pack-priv int	placeholderCount The total number of argument placeholder occurrences.
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	MessagePatternAnalysis()

Method Summary

Modifier and Type	Method and Description
private void	ensurePlaceholderCharIndicesCapacity(final int argCount)

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

Field Detail

escapedCharFound	back to summary
pack-priv boolean escapedCharFound Flag indicating if an escaped (i.e., `\`-prefixed) character is found.

PLACEHOLDER_CHAR_INDEX_BUFFER_INITIAL_SIZE	back to summary
private static final int PLACEHOLDER_CHAR_INDEX_BUFFER_INITIAL_SIZE The size of the `placeholderCharIndices` buffer to be allocated if it is found to be null.

PLACEHOLDER_CHAR_INDEX_BUFFER_SIZE_INCREMENT	back to summary
private static final int PLACEHOLDER_CHAR_INDEX_BUFFER_SIZE_INCREMENT The size `placeholderCharIndices` buffer will be extended with if it has found to be insufficient.

placeholderCharIndices	back to summary
pack-priv int[] placeholderCharIndices The array of indices pointing to the first character of the found argument placeholder occurrences.

placeholderCount	back to summary
pack-priv int placeholderCount The total number of argument placeholder occurrences.

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

MessagePatternAnalysis	back to summary
pack-priv MessagePatternAnalysis()

Method Detail

ensurePlaceholderCharIndicesCapacity	back to summary
private void ensurePlaceholderCharIndicesCapacity(final int argCount)

pack-priv final Class ParameterFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ParameterFormatter.MessagePatternAnalysis

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail