net.sf.aspect4log.text

Class CustomisableMessageBuilderFactory

java.lang.Object

net.sf.aspect4log.text.CustomisableMessageBuilderFactory

All Implemented Interfaces:

MessageBuilderFactory

public class CustomisableMessageBuilderFactory
extends Object
implements MessageBuilderFactory

This class is responsible for creating MessageBuilder instances. Log decoration properties are set by {@link LogFormatConfiguration via reflection.

Author:

yilativs

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD_ENTER_SYMBOL
static String	METHOD_SUCCESSFUL_EXIT_SYMBOL
static String	METHOD_THROWN_EXCEPTION_EXIT_SYMBOL
static String	RETURNED_VALUE_SEPARATOR
static String	THROWN_EXCEPTION_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
CustomisableMessageBuilderFactory()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildIdent()
MessageBuilder	createEnterMessageBuilder(String methodName, Log log, Object[] args)
MessageBuilder	createExceptionReturnMessageBuilder(String methodName, Log log, Object[] args, Throwable throwable, String exceptionExitTemplate)
MessageBuilder	createMdcTemplate(Log log, Object[] args)
MessageBuilder	createSuccessfulReturnMessageBuilder(String methodName, Log log, Object[] args, boolean returnsNothing, Object result)
String	getIndentText()
boolean	isUseIndent()
void	setArrayBeginsBracket(String arrayBeginsBracket)
void	setArrayEndsBracket(String arrayEndsBracket)
void	setElementsDelitmiter(String elementsDelitmiter)
void	setErrorEvaluatingToStringSymbol(String errorValue)
void	setIndentText(String indentText)
void	setIterableBeginsBracket(String iterableBeginsBracket)
void	setIterableEndsBracket(String iterableEndsBracket)
void	setMapKeyValueDelimeter(String mapKeyValueDelimeter)
void	setMethodEnterSymbol(String methodEnterSymbol)
void	setMethodSuccessfulExitSymbol(String methodSuccessfulReturnSymbol)
void	setMethodThrownExceptionExitSymbol(String returnValueSymbol)
void	setNullSymbol(String nullValue)
void	setReturnedValueSeparator(String exceptionValueSymbol)
void	setThrownExceptionSeparator(String methodExceptionReturSymbol)
void	setUndefindedToStringMethodSymbol(String undefindedToStringValue)
void	setUseIndent(boolean useIndent)

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_ENTER_SYMBOL

public static final String METHOD_ENTER_SYMBOL

See Also:

Constant Field Values

METHOD_SUCCESSFUL_EXIT_SYMBOL

public static final String METHOD_SUCCESSFUL_EXIT_SYMBOL

See Also:

Constant Field Values

METHOD_THROWN_EXCEPTION_EXIT_SYMBOL

public static final String METHOD_THROWN_EXCEPTION_EXIT_SYMBOL

See Also:

Constant Field Values

RETURNED_VALUE_SEPARATOR

public static final String RETURNED_VALUE_SEPARATOR

See Also:

Constant Field Values

THROWN_EXCEPTION_SEPARATOR

public static final String THROWN_EXCEPTION_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

CustomisableMessageBuilderFactory

public CustomisableMessageBuilderFactory()

Method Detail

isUseIndent

public boolean isUseIndent()

setUseIndent

public void setUseIndent(boolean useIndent)

getIndentText

public String getIndentText()

setIndentText

public void setIndentText(String indentText)

setElementsDelitmiter

public void setElementsDelitmiter(String elementsDelitmiter)

setMapKeyValueDelimeter

public void setMapKeyValueDelimeter(String mapKeyValueDelimeter)

setArrayBeginsBracket

public void setArrayBeginsBracket(String arrayBeginsBracket)

setArrayEndsBracket

public void setArrayEndsBracket(String arrayEndsBracket)

setIterableBeginsBracket

public void setIterableBeginsBracket(String iterableBeginsBracket)

setIterableEndsBracket

public void setIterableEndsBracket(String iterableEndsBracket)

setUndefindedToStringMethodSymbol

public void setUndefindedToStringMethodSymbol(String undefindedToStringValue)

setNullSymbol

public void setNullSymbol(String nullValue)

setErrorEvaluatingToStringSymbol

public void setErrorEvaluatingToStringSymbol(String errorValue)

setMethodEnterSymbol

public void setMethodEnterSymbol(String methodEnterSymbol)

setMethodSuccessfulExitSymbol

public void setMethodSuccessfulExitSymbol(String methodSuccessfulReturnSymbol)

setMethodThrownExceptionExitSymbol

public void setMethodThrownExceptionExitSymbol(String returnValueSymbol)

setThrownExceptionSeparator

public void setThrownExceptionSeparator(String methodExceptionReturSymbol)

setReturnedValueSeparator

public void setReturnedValueSeparator(String exceptionValueSymbol)

createEnterMessageBuilder

public MessageBuilder createEnterMessageBuilder(String methodName,
                                       Log log,
                                       Object[] args)

Specified by:

createEnterMessageBuilder in interface MessageBuilderFactory

createSuccessfulReturnMessageBuilder

public MessageBuilder createSuccessfulReturnMessageBuilder(String methodName,
                                                  Log log,
                                                  Object[] args,
                                                  boolean returnsNothing,
                                                  Object result)

Specified by:

createSuccessfulReturnMessageBuilder in interface MessageBuilderFactory

createExceptionReturnMessageBuilder

public MessageBuilder createExceptionReturnMessageBuilder(String methodName,
                                                 Log log,
                                                 Object[] args,
                                                 Throwable throwable,
                                                 String exceptionExitTemplate)

Specified by:

createExceptionReturnMessageBuilder in interface MessageBuilderFactory

createMdcTemplate

public MessageBuilder createMdcTemplate(Log log,
                               Object[] args)

Specified by:

createMdcTemplate in interface MessageBuilderFactory

buildIdent

public String buildIdent()

Specified by:

buildIdent in interface MessageBuilderFactory