org.xenei.log4j.recording

Class RecordingAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.xenei.log4j.recording.RecordingAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class RecordingAppender
extends org.apache.log4j.AppenderSkeleton

A logging appender that records the logging events for later testing. Used in junit tests to verify that messages have been written to the log. Tests use a Selector to determine if the logging events are found.

Field Summary

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
RecordingAppender() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	append(org.apache.log4j.spi.LoggingEvent event)
void	assertContains(Selector selector, org.apache.log4j.spi.LoggingEvent... events) Assert that the recorded events contains the list of events in the order specified without intervening events.
void	assertHas(Selector selector, List<org.apache.log4j.spi.LoggingEvent> events) Assert that the recorded events contains the list of events in the order specified without intervening events.
void	assertHasEnd(Selector selector, org.apache.log4j.spi.LoggingEvent... end) Assert that the recorded events ends with the list of events in the order specified without intervening events.
void	assertHasStart(Selector selector, org.apache.log4j.spi.LoggingEvent... start) Assert that the recorded events starts with the list of events in the order specified without intervening events.
void	clear() Clear the list of recorded events.
void	close() Close the appender.
boolean	contains(Selector selector, org.apache.log4j.spi.LoggingEvent... events) Return true if the list of events are found in the recorded events in order without intervening events.
Iterator<org.apache.log4j.spi.LoggingEvent>	from(Selector selector, org.apache.log4j.spi.LoggingEvent start) Returns an iterator over the recorded events following the first instance of the start event.
Iterator<org.apache.log4j.spi.LoggingEvent>	getEvents() Returns an iterator over all the recorded events.
boolean	has(Selector selector, List<org.apache.log4j.spi.LoggingEvent> things) Check that the recorded events contains with the list of events in the order specified without intervening events.
boolean	hasEnd(Selector selector, List<org.apache.log4j.spi.LoggingEvent> events) Check that the recorded events ends with the list of events in the order specified without intervening events.
boolean	hasStart(Selector selector, List<org.apache.log4j.spi.LoggingEvent> events) Check that the recorded events starts with the list of events in the order specified without intervening events.
boolean	requiresLayout()

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingAppender

public RecordingAppender()

Constructor

Method Detail

close

public void close()

Close the appender.

requiresLayout

public boolean requiresLayout()

append

protected void append(org.apache.log4j.spi.LoggingEvent event)

Specified by:

append in class org.apache.log4j.AppenderSkeleton

has

public final boolean has(Selector selector,
                         List<org.apache.log4j.spi.LoggingEvent> things)

Check that the recorded events contains with the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

things - the list of events to expect.

Returns:

true if the events are found in order.

hasStart

public final boolean hasStart(Selector selector,
                              List<org.apache.log4j.spi.LoggingEvent> events)

Check that the recorded events starts with the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

events - the list of events to expect.

Returns:

true if the events are found in order.

hasEnd

public final boolean hasEnd(Selector selector,
                            List<org.apache.log4j.spi.LoggingEvent> events)

Check that the recorded events ends with the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

events - the list of events to expect.

Returns:

true if the events are found in order.

assertHas

public final void assertHas(Selector selector,
                            List<org.apache.log4j.spi.LoggingEvent> events)

Assert that the recorded events contains the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

events - the list of events to expect.

assertContains

public final void assertContains(Selector selector,
                                 org.apache.log4j.spi.LoggingEvent... events)

Assert that the recorded events contains the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

events - the list of events to expect.

assertHasStart

public final void assertHasStart(Selector selector,
                                 org.apache.log4j.spi.LoggingEvent... start)

Assert that the recorded events starts with the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

start - the list of events to expect.

assertHasEnd

public final void assertHasEnd(Selector selector,
                               org.apache.log4j.spi.LoggingEvent... end)

Assert that the recorded events ends with the list of events in the order specified without intervening events.

Parameters:

selector - The selector to use.

end - the list of events to expect.

clear

public final void clear()

Clear the list of recorded events. This allows the appender to be reused.

contains

public final boolean contains(Selector selector,
                              org.apache.log4j.spi.LoggingEvent... events)

Return true if the list of events are found in the recorded events in order without intervening events.

Parameters:

selector - The selector to use.

events - The list of events to check.

Returns:

True if the events are found in the stored events.

getEvents

public final Iterator<org.apache.log4j.spi.LoggingEvent> getEvents()

Returns an iterator over all the recorded events.

Returns:

the iterator.

from

public final Iterator<org.apache.log4j.spi.LoggingEvent> from(Selector selector,
                                                              org.apache.log4j.spi.LoggingEvent start)

Returns an iterator over the recorded events following the first instance of the start event.

Parameters:

selector - The selector to use.

start - The starting event.

Returns:

An iterator of the recorded events.