com.gargoylesoftware.base.trace
Class TraceItem

java.lang.Object
  com.gargoylesoftware.base.trace.TraceItem

All Implemented Interfaces:

java.lang.Cloneable

public class TraceItem
extends java.lang.Object
implements java.lang.Cloneable

An item of data to be written.

Version:

$Revision: 1.6 $

Author:

Mike Bowler

Constructor Summary

TraceItem()
Create a new item.

Method Summary

protected void	assertNotNull(java.lang.String fieldName, java.lang.Object fieldValue) Verify that the specified value is not null.
java.lang.Object	clone() Return a copy of this object.
boolean	containsText() Return true if this item contains any text.
TraceChannel	getChannel() Return the channel.
java.lang.Object	getLock() Return the lock.
java.lang.String	getMessage() Return the message.
TraceItem	getNextItem() Return the next item.
TraceItem	getPrevItem() Return the previous item.
java.lang.String	getThreadName() Return the name of the thread that called Trace.
java.lang.Throwable	getThrowable() Return the throwable.
java.util.Date	getTime() Return the time that the item was written to Trace
java.lang.String	toString() Return a string representation of this object for testing purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceItem

public TraceItem()

Create a new item.

Method Detail

toString

public java.lang.String toString()

Return a string representation of this object for testing purposes.

Overrides:

toString in class java.lang.Object

Returns:

The string representation

containsText

public boolean containsText()

Return true if this item contains any text.

Returns:

true if this item contains any text.

getMessage

public java.lang.String getMessage()

Return the message.

Returns:

the message.

getThrowable

public java.lang.Throwable getThrowable()

Return the throwable.

Returns:

the throwable.

getTime

public java.util.Date getTime()

Return the time that the item was written to Trace

Returns:

the time.

getThreadName

public java.lang.String getThreadName()

Return the name of the thread that called Trace.

Returns:

the name of the thread.

getLock

public java.lang.Object getLock()

Return the lock.

Returns:

the lock.

getPrevItem

public TraceItem getPrevItem()

Return the previous item.

Returns:

the previous item.

getNextItem

public TraceItem getNextItem()

Return the next item.

Returns:

the next item.

getChannel

public TraceChannel getChannel()

Return the channel.

Returns:

the channel.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Return a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

A copy.

Throws:

java.lang.CloneNotSupportedException - If this object is not cloneable.

assertNotNull

protected final void assertNotNull(java.lang.String fieldName,
                                   java.lang.Object fieldValue)
                            throws DetailedNullPointerException

Verify that the specified value is not null. If it is then throw an exception

Parameters:

fieldName - The name of the field to check

fieldValue - The value of the field to check

Throws:

DetailedNullPointerException - If fieldValue is null