ilog.tgo.model

Class IltSimpleState

java.lang.Object

ilog.tgo.model.IltState

ilog.tgo.model.IltSimpleState

All Implemented Interfaces:

IltDecorationSource, IlWithProperties

Direct Known Subclasses:

IltBooleanState, IltNumericState, IltSymbolicState

public abstract class IltSimpleState
extends IltState

This class is the base class for all states which have a single value.

When instances of this class are created, it is possible to define a default value, so that when a telecom object instance is created and uses a state system which contains instances of this state, the default value is automatically assigned to the object.

Field Summary

Fields

Modifier and Type	Field and Description
static IltStateInfo	metainfo Contains metainformation about this IltSimpleState class.

Fields inherited from class ilog.tgo.model.IltState

_message

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltSimpleState(String name, String description, String message, Object defaultValue) Creates an IltSimpleState.

Method Summary

Modifier and Type	Method and Description
Object	createValue() Returns the value for this state.
Object	getDefault() Returns the default value of the state.
boolean	hasDefault() Returns true if this state contains a default value.
void	setDefault(Object value) Sets the default value of the state.

Methods inherited from class ilog.tgo.model.IltState

copy, CreateNameFilter, CreateStateFilter, equals, getAliases, getAllPaths, getAltName, getDescription, getName, getProperty, getStateInfo, getToolTipText, getToolTipText, hasDescription, hashCode, intern, isInside, IsPropertyTransient, isValid, list, removeProperty, setAltName, setDescription, setMessage, setName, setProperty, SetPropertyTransient, toString

Methods inherited from class java.lang.Object

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

Field Detail

metainfo

public static IltStateInfo metainfo

Contains metainformation about this IltSimpleState class.

Constructor Detail

IltSimpleState

protected IltSimpleState(String name,
                         String description,
                         String message,
                         Object defaultValue)

Creates an IltSimpleState.

Parameters:

name - state name

description - optional attribute, which defines a textual description of the state.

message - catalog message, which allows description internationalization.

defaultValue - optional attribute which defines a default value for this state.

Method Detail

hasDefault

public boolean hasDefault()

Returns true if this state contains a default value.

Overrides:

hasDefault in class IltState

getDefault

public Object getDefault()

Returns the default value of the state.

Overrides:

getDefault in class IltState

setDefault

public void setDefault(Object value)
                throws IltInvalidStateValueException

Sets the default value of the state.

Throws:

IltInvalidStateValueException

createValue

public Object createValue()

Returns the value for this state.

Overrides:

createValue in class IltState