org.flexiblepower.efi.util

Class RunningMode<T>

java.lang.Object

org.flexiblepower.efi.util.RunningMode<T>

Type Parameters:

T - The value stored in this RunningMode (depends on where the RunningMode is being used)

public class RunningMode<T>
extends java.lang.Object

This class is used to describe different modes in which a device can run. This is used in both the buffer and the unconstrained abstractions.

Constructor Summary

Constructors

Constructor and Description
RunningMode(int id, java.lang.String name, T value, java.util.Set<Transition> possibleTransitions) Construct a new, immutable RunningMode object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getId()
java.lang.String	getName()
java.util.Collection<Transition>	getTransitions()
Transition	getTransitionTo(int runningModeId)
Transition	getTransitionTo(RunningMode<T> runningMode)
T	getValue()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

RunningMode

public RunningMode(int id,
           java.lang.String name,
           T value,
           java.util.Set<Transition> possibleTransitions)

Construct a new, immutable RunningMode object.

Parameters:

id - Device-unique identifier for this RunningMode

name - Human readable name for this RunningMode

value - Value stored in this RunningMode

possibleTransitions - Possible transitions from this RunningMode to another. This Set should not be empty, unless this is the only RunningMode for this Actuator.

Throws:

java.lang.NullPointerException - Thrown when name, value or possibleTransitions is null

Method Detail

getId

public int getId()

Returns:

A unique identifier (within the context of this device) for this running mode.

getName

public java.lang.String getName()

Returns:

A human readable name for this running mode. E.g. “full power”.

getValue

public T getValue()

Returns:

The value associated with this RunningMode

getTransitions

public java.util.Collection<Transition> getTransitions()

Returns:

A list of zero or more Transition objects that contain constraints for switching from this RunningMode to another. There may be no transition to this RunningMode (itself).

getTransitionTo

public Transition getTransitionTo(RunningMode<T> runningMode)

Parameters:

runningMode - The running mode to switch to

Returns:

The Transition that can be used to move to that RunningMode, or null if that transition is not possible

getTransitionTo

public Transition getTransitionTo(int runningModeId)

Parameters:

runningModeId - The identifier of the running mode to switch to

Returns:

The Transition that can be used to move to the corresponding RunningMode, or null if that transition is not possible

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object