Package adams.gui.flow.tree.record.enclose

Class AbstractRecordActorEnclosed

java.lang.Object

adams.core.logging.ConsoleLoggingObject

adams.gui.flow.tree.record.enclose.AbstractRecordActorEnclosed

All Implemented Interfaces:

CleanUpHandler, Serializable

Direct Known Subclasses:

MostCommon, SimpleLog

public abstract class AbstractRecordActorEnclosed
extends ConsoleLoggingObject
implements CleanUpHandler

Ancestor schemes that record when actor(s) got enclosed.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static List<AbstractRecordActorEnclosed>	m_Recorders	the available recording schemes.

Fields inherited from class adams.core.logging.ConsoleLoggingObject

m_Logger

Constructor Summary

Constructors

Constructor	Description
AbstractRecordActorEnclosed()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
static void	cleanUpAll()	Cleans up data structures, frees up memory, for all recorders.
protected abstract void	doRecord(Tree tree, TreePath[] paths, ActorHandler handler)	Records the enclosing action.
abstract boolean	isEnabled(Tree tree)	Returns whether the recording is active.
void	record(Tree tree, TreePath[] paths, ActorHandler handler)	Records the enclosing action.
static void	recordAll(Tree tree, TreePath[] paths, ActorHandler handler)	Records the actor that was added.

Methods inherited from class adams.core.logging.ConsoleLoggingObject

getLogger, initializeLogger, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Field Detail

m_Recorders

protected static List<AbstractRecordActorEnclosed> m_Recorders

the available recording schemes.

Constructor Detail

AbstractRecordActorEnclosed

public AbstractRecordActorEnclosed()

Method Detail

isEnabled

public abstract boolean isEnabled(Tree tree)

Returns whether the recording is active.

Parameters:

tree - the current tree

Returns:

true if active

doRecord

protected abstract void doRecord(Tree tree,
                                 TreePath[] paths,
                                 ActorHandler handler)

Records the enclosing action.

Parameters:

tree - the context

paths - the paths to add

handler - the handler to enclose the paths with

record

public void record(Tree tree,
                   TreePath[] paths,
                   ActorHandler handler)

Records the enclosing action.

Parameters:

tree - the context

paths - the paths to add

handler - the handler to enclose the paths with

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.
Default implementation does nothing.

Specified by:

cleanUp in interface CleanUpHandler

recordAll

public static void recordAll(Tree tree,
                             TreePath[] paths,
                             ActorHandler handler)

Records the actor that was added.

Parameters:

tree - the context

paths - the paths to add

handler - the handler to enclose the paths with

cleanUpAll

public static void cleanUpAll()

Cleans up data structures, frees up memory, for all recorders.