com.atlassian.jira.startup
Class FormattedLogMsg

java.lang.Object
  com.atlassian.jira.startup.FormattedLogMsg

public class FormattedLogMsg
extends Object

This class will allow a series of messages to be formated/indented into the one log4j ouput.

The idea is to build up a message and then call printMessage(), after which the contents of the message will be cleared and the formatter can be used again to output more messages.

Since:

v3.13

Constructor Summary

FormattedLogMsg()
Use this constructor if you dont intended to write to a Logger

FormattedLogMsg(org.apache.log4j.Logger log)

Method Summary

void	add(Object message)
void	add(Object message, int indentLevel)
void	addAll(Collection<String> collection)
void	outputHeader(String header)
void	outputProperty(String propertyDesc)
void	outputProperty(String propertyDesc, String propertyValue)
void	outputProperty(String propertyDesc, String propertyValue, int indentLevel)
void	outputProperty(String propertyDesc, String propertyValue, String splitStr)
void	outputProperty(String propertyDesc, String propertyValue, String splitStr, int indentLevel)
void	printMessage(org.apache.log4j.Level logLevel) Prints the contents of the current formatted messages to the Logger, using the specified LogLevel.
void	printMessage(org.apache.log4j.Level logLevel, boolean useStars) Prints the contents of the current formatted messages to the Logger, using the specified LogLevel.
String	toString() This will return the FormattedLogMsg as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattedLogMsg

public FormattedLogMsg()

Use this constructor if you dont intended to write to a Logger

FormattedLogMsg

public FormattedLogMsg(org.apache.log4j.Logger log)

Method Detail

add

public void add(Object message)

add

public void add(Object message,
                int indentLevel)

addAll

public void addAll(Collection<String> collection)

outputProperty

public void outputProperty(String propertyDesc)

outputProperty

public void outputProperty(String propertyDesc,
                           String propertyValue)

outputProperty

public void outputProperty(String propertyDesc,
                           String propertyValue,
                           String splitStr)

outputProperty

public void outputProperty(String propertyDesc,
                           String propertyValue,
                           int indentLevel)

outputProperty

public void outputProperty(String propertyDesc,
                           String propertyValue,
                           String splitStr,
                           int indentLevel)

outputHeader

public void outputHeader(String header)

printMessage

public void printMessage(org.apache.log4j.Level logLevel)

Prints the contents of the current formatted messages to the Logger, using the specified LogLevel. * stars will be placed around the text in the log.

The messages data will be cleared after this call, ready for new message output.

Parameters:

logLevel - the log4j log level to output as

printMessage

public void printMessage(org.apache.log4j.Level logLevel,
                         boolean useStars)

Prints the contents of the current formatted messages to the Logger, using the specified LogLevel. * stars will be placed around the text in the log if useStars is true.

The messages data will be cleared after this call, ready for new output.

Parameters:

logLevel - the log4j log level to output as

useStars - if true * characters will be placed around the message output

toString

public String toString()

This will return the FormattedLogMsg as a String. Calling this method does not reset the state of the log message in the way that printMessage() does

Overrides:

toString in class Object

Returns:

the the FormattedLogMsg as a String