org.freehep.record.loop.event
Class RecordAdapter

java.lang.Object
  org.freehep.record.loop.event.RecordAdapter

All Implemented Interfaces:

EventListener, RecordListener

Direct Known Subclasses:

EchoStrings, RejectEvenStrings, Strings2Words

public class RecordAdapter

extends Object

implements RecordListener

It is an implementation of the RecordListener interface where all the methods are empty. It exists a conveniece class for creators of RecordListener objects.

Version:

$Id: RecordAdapter.java,v 1.1 2003/05/06 23:02:05 tonyj Exp $

Author:

patton

Source Code:

RecordAdapter.java

Constructor Summary

RecordAdapter()
Create an instance of this class.

Method Summary

void	configure(ConfigurationEvent event) Tells this object to configure itself in preparation for the first recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) call.
void	finish(RecordEvent event) Tells this object that an SequentialRecordLoop to which is has been added has been disposed of, and this object should execute any housekeeping tasks trelated to its participation in this SequentialRecordLoop.
void	reconfigure(ConfigurationEvent event) Tells this object to reconfigure itself in preparation for a new set of recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) calls.
void	recordSupplied(RecordSuppliedEvent event) Called every time a new record is read by the SequentialRecordLoop's SequentialRecordSource object.
void	resume(RecordEvent event) Tells this object to prepare for a new set of recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) calls using the its existing configuration.
void	suspend(RecordEvent event) Tells this object that there will be either a resume(org.freehep.record.loop.event.RecordEvent) or reconfigure(org.freehep.record.loop.event.ConfigurationEvent) before any more recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) calls will be made.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordAdapter

public RecordAdapter()

Create an instance of this class.

Method Detail

configure

public void configure(ConfigurationEvent event)

Description copied from interface: RecordListener

Tells this object to configure itself in preparation for the first RecordListener.recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) call.

Specified by:

configure in interface RecordListener

Parameters:

event - a ConfigurationEvent describing the configuration to use.

finish

public void finish(RecordEvent event)

Description copied from interface: RecordListener

Tells this object that an SequentialRecordLoop to which is has been added has been disposed of, and this object should execute any housekeeping tasks trelated to its participation in this SequentialRecordLoop.

Specified by:

finish in interface RecordListener

Parameters:

event - the RecordEvent for this event.

recordSupplied

public void recordSupplied(RecordSuppliedEvent event)

Description copied from interface: RecordListener

Called every time a new record is read by the SequentialRecordLoop's SequentialRecordSource object.

Specified by:

recordSupplied in interface RecordListener

Parameters:

event - a RecordSuppliedEvent describing the data supplied.

reconfigure

public void reconfigure(ConfigurationEvent event)

Description copied from interface: RecordListener

Tells this object to reconfigure itself in preparation for a new set of RecordListener.recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) calls.

Specified by:

reconfigure in interface RecordListener

Parameters:

event - a ConfigurationEvent describing the new configuration to use.

resume

public void resume(RecordEvent event)

Description copied from interface: RecordListener

Tells this object to prepare for a new set of RecordListener.recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) calls using the its existing configuration.

Specified by:

resume in interface RecordListener

Parameters:

event - the RecordEvent for this event.

suspend

public void suspend(RecordEvent event)

Description copied from interface: RecordListener

Tells this object that there will be either a RecordListener.resume(org.freehep.record.loop.event.RecordEvent) or RecordListener.reconfigure(org.freehep.record.loop.event.ConfigurationEvent) before any more RecordListener.recordSupplied(org.freehep.record.loop.event.RecordSuppliedEvent) calls will be made.

Specified by:

suspend in interface RecordListener

Parameters:

event - the RecordEvent for this event.