Package adams.flow.processor

Interface ActorProcessor

All Superinterfaces:

Comparable<ActorProcessor>, Destroyable, OptionHandler, ShallowCopySupporter<ActorProcessor>

All Known Subinterfaces:

ActorProcessorWithFlowPanelContext, CleanUpProcessor, GraphicalOutputProducingProcessor, InteractiveProcessor, ListingProcessor, ModifyingProcessor

All Known Implementing Classes:

AbstractActorListingProcessor, AbstractActorProcessor, AbstractListingProcessor, AbstractListNameUsage, AbstractModifyingInteractiveProcessor, AbstractModifyingProcessor, AbstractNameUpdater, ActorStatistics, ChangeDatabaseConditionLimit, ChangeDatabaseConnection, ChangeDisplayType, ChangeNumThreads, ChangePath, CheckActorReferenceUsage, CheckPlaceholders, CheckStorageUsage, CheckVariableUsage, FindText, FlattenStructure, ForwardSlashSwitch, ListActorReferenceUsage, ListActorUsage, ListAllStorageNames, ListAllVariables, ListAnnotationTags, ListCallableActorUsage, ListClassUsage, ListDatabaseConnections, ListObjectCommandlines, ListPaths, ListStorageUsage, ListStructureModifyingActors, ListTODOs, ListVariableUsage, ManageInteractiveActors, ManageTimedActors, MultiProcessor, ReactivateActors, RemoveAutogeneratedActors, RemoveBreakpoints, RemoveDisabledActors, RemoveUnusedReferenceableActors, SwapObjects, UpdateCallableActorName, UpdateEventName, UpdateStorageName, UpdateVariableName

public interface ActorProcessor
extends OptionHandler, Comparable<ActorProcessor>, ShallowCopySupporter<ActorProcessor>

Interface for actor processors.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ActorProcessor o)	Compares this object with the specified object for order.
List<String>	getErrors()	Returns the list of errors (if any).
boolean	hasErrors()	Checks whether any errors were encountered.
void	process(Actor actor)	Processes the actor.
ActorProcessor	shallowCopy()	Returns a shallow copy of itself, i.e., based on the commandline options.
ActorProcessor	shallowCopy(boolean expand)	Returns a shallow copy of itself, i.e., based on the commandline options.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Method Detail

process

void process(Actor actor)

Processes the actor.

Parameters:

actor - the actor to process

hasErrors

boolean hasErrors()

Checks whether any errors were encountered.

Returns:

true if errors were encountered

See Also:

getErrors()

getErrors

List<String> getErrors()

Returns the list of errors (if any).

Returns:

the errors

compareTo

int compareTo(ActorProcessor o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Only compares the commandlines of the two objects.

Specified by:

compareTo in interface Comparable<ActorProcessor>

Parameters:

o - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

ClassCastException - if the specified object's type prevents it from being compared to this object.

shallowCopy

ActorProcessor shallowCopy()

Returns a shallow copy of itself, i.e., based on the commandline options.

Specified by:

shallowCopy in interface ShallowCopySupporter<ActorProcessor>

Returns:

the shallow copy

shallowCopy

ActorProcessor shallowCopy(boolean expand)

Returns a shallow copy of itself, i.e., based on the commandline options.

Specified by:

shallowCopy in interface ShallowCopySupporter<ActorProcessor>

Parameters:

expand - whether to expand variables to their current values

Returns:

the shallow copy