Package jmri.implementation

Class DefaultConditionalAction

java.lang.Object

jmri.implementation.DefaultConditionalAction

All Implemented Interfaces:

ConditionalAction

public class DefaultConditionalAction
extends Object
implements ConditionalAction

The consequent of the antecedent of the conditional proposition. The data for the action to be taken when a Conditional calculates to True

This is in the implementations package because of a Swing dependence via the times. Java 1.5 or Java 1.6 might make it possible to break that, which will simplify things.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final ResourceBundle	rbx

Constructor Summary

Constructors

Constructor	Description
DefaultConditionalAction()
DefaultConditionalAction(int option, Conditional.Action type, String name, int actionData, String actionStr)

Method Summary

Modifier and Type	Method	Description
String	description(boolean triggerType)	Get an I18N description of the ConditionAction.
void	dispose()	Dispose this ConditionalAction.
boolean	equals(Object obj)
int	getActionData()	Integer data for action.
String	getActionDataString()	Get an I18N String to represent the Action Data.
static String	getActionDataString(Conditional.Action t, int data)	Get the Action Data String in I18N form.
String	getActionString()	String data for action.
NamedBean	getBean()
String	getDeviceName()	Name of the device or element that is affected.
ActionListener	getListener()
NamedBeanHandle<?>	getNamedBean()
int	getOption()	Options on when action is taken.
String	getOptionString(boolean type)	Get the Option String in I18N format.
static String	getOptionString(int opt, boolean type)	Convert consequent option to I18N String.
Sound	getSound()	Get Sound file.
Timer	getTimer()
Conditional.Action	getType()	The consequent device or element type.
String	getTypeString()
int	hashCode()
boolean	isTimerActive()
void	setActionData(int actionData)
void	setActionData(String actionData)	Set action data from I18N name for it.
void	setActionString(String actionString)	Set the Action String.
void	setDeviceName(String deviceName)
void	setListener(ActionListener listener)
void	setOption(int option)	Set the Action Option.
protected void	setSound(Sound sound)	Set the sound file.
void	setTimer(Timer timer)
void	setType(String type)	Set type from user name for it.
void	setType(Conditional.Action type)
void	startTimer()
void	stopTimer()
static int	stringToActionData(String str)	Get action Data from an I18N String.
static Conditional.Action	stringToActionType(String str)	Get action type from a String.

Methods inherited from class java.lang.Object

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

Field Details

rbx

static final ResourceBundle rbx

Constructor Details

DefaultConditionalAction

public DefaultConditionalAction()

DefaultConditionalAction

public DefaultConditionalAction(int option,
 @Nonnull
 Conditional.Action type,
 String name,
 int actionData,
 String actionStr)

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getType

@Nonnull
public Conditional.Action getType()

The consequent device or element type.

Specified by:

getType in interface ConditionalAction

Returns:

the type

setType

public void setType(@Nonnull
 Conditional.Action type)

Specified by:

setType in interface ConditionalAction

setType

public void setType(String type)

Set type from user name for it.

Specified by:

setType in interface ConditionalAction

Parameters:

type - name of the type

getDeviceName

public String getDeviceName()

Name of the device or element that is affected.

Specified by:

getDeviceName in interface ConditionalAction

Returns:

the name

setDeviceName

public void setDeviceName(String deviceName)

Specified by:

setDeviceName in interface ConditionalAction

getNamedBean

@CheckForNull
public NamedBeanHandle<?> getNamedBean()

Specified by:

getNamedBean in interface ConditionalAction

getBean

@CheckForNull
public NamedBean getBean()

Specified by:

getBean in interface ConditionalAction

getOption

public int getOption()

Options on when action is taken.

Specified by:

getOption in interface ConditionalAction

Returns:

the option

setOption

public void setOption(int option)

Description copied from interface: ConditionalAction

Set the Action Option.

Specified by:

setOption in interface ConditionalAction

Parameters:

option - the action option number.

getActionData

public int getActionData()

Integer data for action.

Specified by:

getActionData in interface ConditionalAction

Returns:

the data

setActionData

public void setActionData(int actionData)

Specified by:

setActionData in interface ConditionalAction

setActionData

public void setActionData(String actionData)

Set action data from I18N name for it.

Specified by:

setActionData in interface ConditionalAction

Parameters:

actionData - user name

getActionString

@Nonnull
public String getActionString()

String data for action.

Specified by:

getActionString in interface ConditionalAction

Returns:

the action String

setActionString

public void setActionString(String actionString)

Description copied from interface: ConditionalAction

Set the Action String. Any String float values ( delayed Sensor ) should use a . decimal separator.

Specified by:

setActionString in interface ConditionalAction

Parameters:

actionString - the action String.

getTimer

@CheckForNull
public Timer getTimer()

Specified by:

getTimer in interface ConditionalAction

setTimer

public void setTimer(Timer timer)

Specified by:

setTimer in interface ConditionalAction

isTimerActive

public boolean isTimerActive()

Specified by:

isTimerActive in interface ConditionalAction

startTimer

public void startTimer()

Specified by:

startTimer in interface ConditionalAction

stopTimer

public void stopTimer()

Specified by:

stopTimer in interface ConditionalAction

getListener

@CheckForNull
public ActionListener getListener()

Specified by:

getListener in interface ConditionalAction

setListener

public void setListener(ActionListener listener)

Specified by:

setListener in interface ConditionalAction

getSound

@CheckForNull
public Sound getSound()

Get Sound file.

Specified by:

getSound in interface ConditionalAction

Returns:

the sound

setSound

protected void setSound(Sound sound)

Set the sound file.

Parameters:

sound - the new sound file

getTypeString

@Nonnull
public String getTypeString()

Specified by:

getTypeString in interface ConditionalAction

Returns:

name of this consequent type

getOptionString

@Nonnull
public String getOptionString(boolean type)

Description copied from interface: ConditionalAction

Get the Option String in I18N format.

Specified by:

getOptionString in interface ConditionalAction

Parameters:

type - true if option is a change; false if option is a trigger.

Returns:

name of the option for this consequent type

getActionDataString

@Nonnull
public String getActionDataString()

Description copied from interface: ConditionalAction

Get an I18N String to represent the Action Data.

Specified by:

getActionDataString in interface ConditionalAction

Returns:

human readable String of the data.

getOptionString

@Nonnull
public static String getOptionString(int opt,
 boolean type)

Convert consequent option to I18N String.

Parameters:

opt - the option.

type - true if option is a change; false if option is a trigger.

Returns:

a human readable description of the option or an empty String.

stringToActionType

@Nonnull
public static Conditional.Action stringToActionType(@CheckForNull
 String str)

Get action type from a String.

Parameters:

str - the string to get the type for

Returns:

the type or 0 if str is not a recognized action

stringToActionData

public static int stringToActionData(@Nonnull
 String str)

Get action Data from an I18N String.

Parameters:

str - the I18N string to get the action data for.

Returns:

the action data of -1 is str is not recognized.

getActionDataString

@Nonnull
public static String getActionDataString(@Nonnull
 Conditional.Action t,
 int data)

Get the Action Data String in I18N form.

Parameters:

t - the Condition.Action, must be null.

data - the constant for the action command type.

Returns:

the action / data string.

description

@Nonnull
public String description(boolean triggerType)

Get an I18N description of the ConditionAction.

Specified by:

description in interface ConditionalAction

Parameters:

triggerType - true if option is a change; false if option is a trigger.

Returns:

human readable description.

dispose

public void dispose()

Dispose this ConditionalAction.

Specified by:

dispose in interface ConditionalAction