Modifier and Type	Class and Description
private static class	XmlLogger.TimedElement Utility class representing the time an element started.

Field Summary

Modifier and Type	Field and Description
private static final String	BUILD_TAG XML element name for a build.
private XmlLogger.TimedElement	buildElement When the build started.
private static DocumentBuilder	builder DocumentBuilder to use when creating the document to start with.
private Document	doc The complete log document for this build.
private static final String	ERROR_ATTR XML attribute name for an error description.
private static final String	LOCATION_ATTR XML attribute name for a file location.
private static final String	MESSAGE_TAG XML element name for a message.
private int	msgOutputLevel
private static final String	NAME_ATTR XML attribute name for a name.
private PrintStream	outStream
private static final String	PRIORITY_ATTR XML attribute name for a message priority.
private static final String	STACKTRACE_TAG XML element name for a stack trace.
private static final String	TARGET_TAG XML element name for a target.
private Map<Target, XmlLogger.TimedElement>	targets Mapping for when targets started (Target to TimedElement).
private static final String	TASK_TAG XML element name for a task.
private Map<Task, XmlLogger.TimedElement>	tasks Mapping for when tasks started (Task to TimedElement).
private Map<Thread, Stack<XmlLogger.TimedElement>>	threadStacks Mapping of threads to stacks of elements (Thread to Stack of TimedElement).
private static final String	TIME_ATTR XML attribute name for a time.

Constructor Summary

Access	Constructor and Description
public	XmlLogger()

Method Summary

Modifier and Type	Method and Description
public void	buildFinished(BuildEvent An event with any relevant extra information. Will not be `null`. event) Implements org.apache.tools.ant.BuildListener.buildFinished. Fired when the build finishes, this adds the time taken and any error stacktrace to the build element and writes the document to disk.
public void	buildStarted(BuildEvent Ignored. event) Implements org.apache.tools.ant.BuildListener.buildStarted. Fired when the build starts, this builds the top-level element for the document and remembers the time of the start of the build.
private static DocumentBuilder	Returns: a default DocumentBuilder instance. getDocumentBuilder() Returns a default DocumentBuilder instance or throws an ExceptionInInitializerError if it can't be created.
public int	getMessageOutputLevel() Overrides default org.apache.tools.ant.BuildLogger.getMessageOutputLevel.
private String	getProperty(BuildEvent event, String propertyName, String defaultValue)
private Stack<XmlLogger.TimedElement>	Returns: the stack of timed elements for the current thread getStack() Returns the stack of timed elements for the current thread.
private XmlLogger.TimedElement	getTaskElement(Task task) Get the TimedElement associated with a task.
public void	messageLogged(BuildEvent An event with any relevant extra information. Will not be `null`. event) Implements org.apache.tools.ant.BuildListener.messageLogged. Fired when a message is logged, this adds a message element to the most appropriate parent element (task, target or build) and records the priority and text of the message.
public void	setEmacsMode(boolean true if logger should produce emacs compatible output emacsMode) Implements org.apache.tools.ant.BuildLogger.setEmacsMode. Ignore emacs mode, as it has no meaning in XML format
public void	setErrorPrintStream(PrintStream the stream we are going to ignore. err) Implements org.apache.tools.ant.BuildLogger.setErrorPrintStream. Ignore error print stream.
public void	setMessageOutputLevel(int the logging level - see `Project` class for level definitions level) Implements org.apache.tools.ant.BuildLogger.setMessageOutputLevel. Set the logging level when using this as a Logger
public void	setOutputPrintStream(PrintStream the output PrintStream. output) Implements org.apache.tools.ant.BuildLogger.setOutputPrintStream. Set the output stream to which logging output is sent when operating as a logger.
private void	synchronizedAppend(Node parent, Node child)
public void	targetFinished(BuildEvent An event with any relevant extra information. Will not be `null`. event) Implements org.apache.tools.ant.BuildListener.targetFinished. Fired when a target finishes building, this adds the time taken and any error stacktrace to the appropriate target element in the log.
public void	targetStarted(BuildEvent An event with any relevant extra information. Will not be `null`. event) Implements org.apache.tools.ant.BuildListener.targetStarted. Fired when a target starts building, this pushes a timed element for the target onto the stack of elements for the current thread, remembering the current time and the name of the target.
public void	taskFinished(BuildEvent An event with any relevant extra information. Will not be `null`. event) Implements org.apache.tools.ant.BuildListener.taskFinished. Fired when a task finishes building, this adds the time taken and any error stacktrace to the appropriate task element in the log.
public void	taskStarted(BuildEvent An event with any relevant extra information. Will not be `null`. event) Implements org.apache.tools.ant.BuildListener.taskStarted. Fired when a task starts building, this pushes a timed element for the task onto the stack of elements for the current thread, remembering the current time and the name of the task.

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

Field Detail

BUILD_TAG	back to summary
private static final String BUILD_TAG XML element name for a build.

buildElement	back to summary
private XmlLogger.TimedElement buildElement When the build started.

builder	back to summary
private static DocumentBuilder builder DocumentBuilder to use when creating the document to start with.

doc	back to summary
private Document doc The complete log document for this build.

ERROR_ATTR	back to summary
private static final String ERROR_ATTR XML attribute name for an error description.

LOCATION_ATTR	back to summary
private static final String LOCATION_ATTR XML attribute name for a file location.

MESSAGE_TAG	back to summary
private static final String MESSAGE_TAG XML element name for a message.

msgOutputLevel	back to summary
private int msgOutputLevel

NAME_ATTR	back to summary
private static final String NAME_ATTR XML attribute name for a name.

outStream	back to summary
private PrintStream outStream

PRIORITY_ATTR	back to summary
private static final String PRIORITY_ATTR XML attribute name for a message priority.

STACKTRACE_TAG	back to summary
private static final String STACKTRACE_TAG XML element name for a stack trace.

TARGET_TAG	back to summary
private static final String TARGET_TAG XML element name for a target.

targets	back to summary
private Map<Target, XmlLogger.TimedElement> targets Mapping for when targets started (Target to TimedElement).

TASK_TAG	back to summary
private static final String TASK_TAG XML element name for a task.

tasks	back to summary
private Map<Task, XmlLogger.TimedElement> tasks Mapping for when tasks started (Task to TimedElement).

threadStacks	back to summary
private Map<Thread, Stack<XmlLogger.TimedElement>> threadStacks Mapping of threads to stacks of elements (Thread to Stack of TimedElement).

TIME_ATTR	back to summary
private static final String TIME_ATTR XML attribute name for a time.

Constructor Detail

XmlLogger	back to summary
public XmlLogger()

Method Detail

buildFinished back to summary

buildFinished	back to summary
public void buildFinished(BuildEvent event) Implements org.apache.tools.ant.BuildListener.buildFinished. Fired when the build finishes, this adds the time taken and any error stacktrace to the build element and writes the document to disk. Parameters event:BuildEvent An event with any relevant extra information. Will not be `null`. Annotations @Override

public void buildFinished(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.buildFinished.

Fired when the build finishes, this adds the time taken and any error stacktrace to the build element and writes the document to disk.

Parameters

event:BuildEvent: An event with any relevant extra information. Will not be null.

Annotations

@Override

buildStarted	back to summary
public void buildStarted(BuildEvent event) Implements org.apache.tools.ant.BuildListener.buildStarted. Fired when the build starts, this builds the top-level element for the document and remembers the time of the start of the build. Parameters event:BuildEvent Ignored. Annotations @Override

buildStarted

back to summary

public void buildStarted(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.buildStarted.

Fired when the build starts, this builds the top-level element for the document and remembers the time of the start of the build.

Parameters

event:BuildEvent: Ignored.

Annotations

@Override

getDocumentBuilder	back to summary
private static DocumentBuilder getDocumentBuilder() Returns a default DocumentBuilder instance or throws an ExceptionInInitializerError if it can't be created. Returns:DocumentBuilder a default DocumentBuilder instance.

getDocumentBuilder

back to summary

private static DocumentBuilder getDocumentBuilder()

Returns a default DocumentBuilder instance or throws an ExceptionInInitializerError if it can't be created.

Returns:DocumentBuilder: a default DocumentBuilder instance.

getMessageOutputLevel back to summary

getMessageOutputLevel	back to summary
public int getMessageOutputLevel() Overrides default org.apache.tools.ant.BuildLogger.getMessageOutputLevel. Returns:int Doc from org.apache.tools.ant.BuildLogger.getMessageOutputLevel. Returns the `currently set` message output level. The `default` implementation of this method returns `MSG_INFO`. Annotations @Override

public int getMessageOutputLevel()

Overrides default org.apache.tools.ant.BuildLogger.getMessageOutputLevel.

Returns:int

Doc from org.apache.tools.ant.BuildLogger.getMessageOutputLevel.

Returns the currently set message output level. The default implementation of this method returns MSG_INFO.

Annotations

@Override

getProperty	back to summary
private String getProperty(BuildEvent event, String propertyName, String defaultValue)

getStack	back to summary
private Stack<XmlLogger.TimedElement> getStack() Returns the stack of timed elements for the current thread. Returns:Stack<XmlLogger.TimedElement> the stack of timed elements for the current thread

getStack

back to summary

private Stack<XmlLogger.TimedElement> getStack()

Returns the stack of timed elements for the current thread.

Returns:Stack<XmlLogger.TimedElement>: the stack of timed elements for the current thread

getTaskElement	back to summary
private XmlLogger.TimedElement getTaskElement(Task task) Get the TimedElement associated with a task. Where the task is not found directly, search for unknown elements which may be hiding the real task

messageLogged back to summary

messageLogged	back to summary
public void messageLogged(BuildEvent event) Implements org.apache.tools.ant.BuildListener.messageLogged. Fired when a message is logged, this adds a message element to the most appropriate parent element (task, target or build) and records the priority and text of the message. Parameters event:BuildEvent An event with any relevant extra information. Will not be `null`. Annotations @Override

public void messageLogged(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.messageLogged.

Fired when a message is logged, this adds a message element to the most appropriate parent element (task, target or build) and records the priority and text of the message.

Parameters

event:BuildEvent: An event with any relevant extra information. Will not be null.

Annotations

@Override

setEmacsMode	back to summary
public void setEmacsMode(boolean emacsMode) Implements org.apache.tools.ant.BuildLogger.setEmacsMode. Ignore emacs mode, as it has no meaning in XML format Parameters emacsMode:boolean true if logger should produce emacs compatible output Annotations @Override

setEmacsMode

back to summary

public void setEmacsMode(boolean emacsMode)

Implements org.apache.tools.ant.BuildLogger.setEmacsMode.

Ignore emacs mode, as it has no meaning in XML format

Parameters

emacsMode:boolean: true if logger should produce emacs compatible output

Annotations

@Override

setErrorPrintStream	back to summary
public void setErrorPrintStream(PrintStream err) Implements org.apache.tools.ant.BuildLogger.setErrorPrintStream. Ignore error print stream. All output will be written to either the XML log file or the PrintStream provided to setOutputPrintStream Parameters err:PrintStream the stream we are going to ignore. Annotations @Override

setErrorPrintStream

back to summary

public void setErrorPrintStream(PrintStream err)

Implements org.apache.tools.ant.BuildLogger.setErrorPrintStream.

Ignore error print stream. All output will be written to either the XML log file or the PrintStream provided to setOutputPrintStream

Parameters

err:PrintStream: the stream we are going to ignore.

Annotations

@Override

setMessageOutputLevel back to summary

setMessageOutputLevel	back to summary
public void setMessageOutputLevel(int level) Implements org.apache.tools.ant.BuildLogger.setMessageOutputLevel. Set the logging level when using this as a Logger Parameters level:int the logging level - see `Project` class for level definitions Annotations @Override

public void setMessageOutputLevel(int level)

Implements org.apache.tools.ant.BuildLogger.setMessageOutputLevel.

Set the logging level when using this as a Logger

Parameters

level:int: the logging level - see Project class for level definitions

Annotations

@Override

setOutputPrintStream	back to summary
public void setOutputPrintStream(PrintStream output) Implements org.apache.tools.ant.BuildLogger.setOutputPrintStream. Set the output stream to which logging output is sent when operating as a logger. Parameters output:PrintStream the output PrintStream. Annotations @Override

setOutputPrintStream

back to summary

public void setOutputPrintStream(PrintStream output)

Implements org.apache.tools.ant.BuildLogger.setOutputPrintStream.

Set the output stream to which logging output is sent when operating as a logger.

Parameters

output:PrintStream: the output PrintStream.

Annotations

@Override

synchronizedAppend	back to summary
private void synchronizedAppend(Node parent, Node child)

targetFinished back to summary

targetFinished	back to summary
public void targetFinished(BuildEvent event) Implements org.apache.tools.ant.BuildListener.targetFinished. Fired when a target finishes building, this adds the time taken and any error stacktrace to the appropriate target element in the log. Parameters event:BuildEvent An event with any relevant extra information. Will not be `null`. Annotations @Override

public void targetFinished(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.targetFinished.

Fired when a target finishes building, this adds the time taken and any error stacktrace to the appropriate target element in the log.

Parameters

event:BuildEvent: An event with any relevant extra information. Will not be null.

Annotations

@Override

targetStarted back to summary

targetStarted	back to summary
public void targetStarted(BuildEvent event) Implements org.apache.tools.ant.BuildListener.targetStarted. Fired when a target starts building, this pushes a timed element for the target onto the stack of elements for the current thread, remembering the current time and the name of the target. Parameters event:BuildEvent An event with any relevant extra information. Will not be `null`. Annotations @Override

public void targetStarted(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.targetStarted.

Fired when a target starts building, this pushes a timed element for the target onto the stack of elements for the current thread, remembering the current time and the name of the target.

Parameters

event:BuildEvent: An event with any relevant extra information. Will not be null.

Annotations

@Override

taskFinished back to summary

taskFinished	back to summary
public void taskFinished(BuildEvent event) Implements org.apache.tools.ant.BuildListener.taskFinished. Fired when a task finishes building, this adds the time taken and any error stacktrace to the appropriate task element in the log. Parameters event:BuildEvent An event with any relevant extra information. Will not be `null`. Annotations @Override

public void taskFinished(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.taskFinished.

Fired when a task finishes building, this adds the time taken and any error stacktrace to the appropriate task element in the log.

Parameters

event:BuildEvent: An event with any relevant extra information. Will not be null.

Annotations

@Override

taskStarted back to summary

taskStarted	back to summary
public void taskStarted(BuildEvent event) Implements org.apache.tools.ant.BuildListener.taskStarted. Fired when a task starts building, this pushes a timed element for the task onto the stack of elements for the current thread, remembering the current time and the name of the task. Parameters event:BuildEvent An event with any relevant extra information. Will not be `null`. Annotations @Override

public void taskStarted(BuildEvent event)

Implements org.apache.tools.ant.BuildListener.taskStarted.

Fired when a task starts building, this pushes a timed element for the task onto the stack of elements for the current thread, remembering the current time and the name of the task.

Parameters

event:BuildEvent: An event with any relevant extra information. Will not be null.

Annotations

@Override

org.apache.tools.ant back to summary

private Class XmlLogger.TimedElement

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.XmlLogger.TimedElement

Utility class representing the time an element started.

Field Summary

Modifier and Type	Field and Description
private Element	element Element created at the start time.
private long	startTime Start time in milliseconds (as returned by `System.currentTimeMillis()`).

Constructor Summary

Access	Constructor and Description
private	TimedElement()

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

element	back to summary
private Element element Element created at the start time.

startTime	back to summary
private long startTime Start time in milliseconds (as returned by `System.currentTimeMillis()`).

Constructor Detail

TimedElement	back to summary
private TimedElement()

Method Detail

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. Returns:String a string representation of the object. Annotations @Override

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.

Returns:String

a string representation of the object.

Annotations