Package org.slf4j.helpers

Class NormalizedParameters

java.lang.Object

org.slf4j.helpers.NormalizedParameters

public class NormalizedParameters
extends java.lang.Object

Holds normalized call parameters. Includes utility methods such as normalize(String, Object[], Throwable) to help the normalization of parameters.

Since:

2.0

Author:

ceki

Constructor Summary

Constructors

Constructor	Description
NormalizedParameters(java.lang.String message, java.lang.Object[] arguments)
NormalizedParameters(java.lang.String message, java.lang.Object[] arguments, java.lang.Throwable throwable)

Method Summary

Modifier and Type	Method	Description
java.lang.Object[]	getArguments()
java.lang.String	getMessage()
java.lang.Throwable	getThrowable()
static java.lang.Throwable	getThrowableCandidate(java.lang.Object[] argArray)	Helper method to determine if an Object array contains a Throwable as last element
static NormalizedParameters	normalize(java.lang.String msg, java.lang.Object[] arguments, java.lang.Throwable t)	This method serves to normalize logging call invocation parameters.
static NormalizedParameters	normalize(LoggingEvent event)
static java.lang.Object[]	trimmedCopy(java.lang.Object[] argArray)	Helper method to get all but the last element of an array

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NormalizedParameters

public NormalizedParameters(java.lang.String message,
                            java.lang.Object[] arguments,
                            java.lang.Throwable throwable)

NormalizedParameters

public NormalizedParameters(java.lang.String message,
                            java.lang.Object[] arguments)

Method Detail

getMessage

public java.lang.String getMessage()

getArguments

public java.lang.Object[] getArguments()

getThrowable

public java.lang.Throwable getThrowable()

getThrowableCandidate

public static java.lang.Throwable getThrowableCandidate(java.lang.Object[] argArray)

Helper method to determine if an Object array contains a Throwable as last element

Parameters:

argArray - The arguments off which we want to know if it contains a Throwable as last element

Returns:

if the last Object in argArray is a Throwable this method will return it, otherwise it returns null

trimmedCopy

public static java.lang.Object[] trimmedCopy(java.lang.Object[] argArray)

Helper method to get all but the last element of an array

Parameters:

argArray - The arguments from which we want to remove the last element

Returns:

a copy of the array without the last element

normalize

public static NormalizedParameters normalize(java.lang.String msg,
                                             java.lang.Object[] arguments,
                                             java.lang.Throwable t)

This method serves to normalize logging call invocation parameters. More specifically, if a throwable argument is not supplied directly, it attempts to extract it from the argument array.

normalize

public static NormalizedParameters normalize(LoggingEvent event)