Package adams.flow.processor

Class ForwardSlashSwitch

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.AbstractModifyingProcessor

adams.flow.processor.ForwardSlashSwitch

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, ModifyingProcessor, Serializable, Comparable<ActorProcessor>

public class ForwardSlashSwitch
extends AbstractModifyingProcessor

Processor that switches the flag of all ForwardSlashSupporter objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_ExcludeDefaultValueDefinition	whether to exclude the EnterManyValues' DefaultValueDefinition.
protected boolean	m_UseForwardSlashes	whether to use forward slashes.

Fields inherited from class adams.flow.processor.AbstractModifyingProcessor

m_Modified, m_ModifiedActor, m_NoCopy

Fields inherited from class adams.flow.processor.AbstractActorProcessor

m_Errors

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ForwardSlashSwitch()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	excludeDefaultValueDefinitionTipText()	Returns the tip text for this property.
boolean	getExcludeDefaultValueDefinition()	Returns whether to exclude DefaultValueDefinition instances as used by EnterManyValues.
boolean	getUseForwardSlashes()	Returns what to update the ForwardSlashSupporter objects to.
String	globalInfo()	Returns a string describing the object.
protected void	processActor(Actor actor)	Performs the actual processing.
void	setExcludeDefaultValueDefinition(boolean value)	Sets whether to exclude DefaultValueDefinition instances as used by EnterManyValues.
void	setUseForwardSlashes(boolean value)	Sets what to update the ForwardSlashSupporter objects to.
String	useForwardSlashesTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.processor.AbstractModifyingProcessor

getModifiedActor, getNoCopy, initialize, isModified, process, setNoCopy

Methods inherited from class adams.flow.processor.AbstractActorProcessor

addError, addError, checkData, compareTo, equals, getErrors, hasErrors, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.processor.ActorProcessor

compareTo, getErrors, hasErrors, shallowCopy, shallowCopy

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_UseForwardSlashes

protected boolean m_UseForwardSlashes

whether to use forward slashes.

m_ExcludeDefaultValueDefinition

protected boolean m_ExcludeDefaultValueDefinition

whether to exclude the EnterManyValues' DefaultValueDefinition.

Constructor Detail

ForwardSlashSwitch

public ForwardSlashSwitch()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setUseForwardSlashes

public void setUseForwardSlashes(boolean value)

Sets what to update the ForwardSlashSupporter objects to.

Parameters:

value - if true then use forward slashes

getUseForwardSlashes

public boolean getUseForwardSlashes()

Returns what to update the ForwardSlashSupporter objects to.

Returns:

true if forward slashes are used

useForwardSlashesTipText

public String useForwardSlashesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setExcludeDefaultValueDefinition

public void setExcludeDefaultValueDefinition(boolean value)

Sets whether to exclude DefaultValueDefinition instances as used by EnterManyValues.

Parameters:

value - true if to exclude

getExcludeDefaultValueDefinition

public boolean getExcludeDefaultValueDefinition()

Returns whether to exclude DefaultValueDefinition instances as used by EnterManyValues.

Returns:

true if to exclude

excludeDefaultValueDefinitionTipText

public String excludeDefaultValueDefinitionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

processActor

protected void processActor(Actor actor)

Performs the actual processing.

Specified by:

processActor in class AbstractActorProcessor

Parameters:

actor - the actor to process (is a copy of original for processors implementing ModifyingProcessor)

See Also:

ModifyingProcessor