ilog.tgo.model

Class IltBooleanState

java.lang.Object

ilog.tgo.model.IltState

ilog.tgo.model.IltSimpleState

ilog.tgo.model.IltBooleanState

All Implemented Interfaces:

IltDecorationSource, IlWithProperties

public class IltBooleanState
extends IltSimpleState

This class models states which have boolean values.

Instances of this class should only be set together with an associated value. The value must be of type boolean or Boolean.

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

Internal use only.

See Also:

IltObjectState.getBoolean(ilog.tgo.model.IltBooleanState), IltObjectState.setBoolean(ilog.tgo.model.IltBooleanState, boolean)

Field Summary

Fields

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

Fields inherited from class ilog.tgo.model.IltState

_message

Constructor Summary

Constructors

Constructor and Description
IltBooleanState(String name, String description, String message) Creates an IltBooleanState.
IltBooleanState(String name, String description, String message, boolean defaultValue) Creates an IltBooleanState.

Method Summary

Modifier and Type	Method and Description
boolean	isValid(Object value) This method verifies if the given value can be set in the state.
void	list(IlpContext context, IltStateListing listing, Object value) Generates a plain text listing of a state.

Methods inherited from class ilog.tgo.model.IltSimpleState

createValue, getDefault, hasDefault, setDefault

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, 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 IltNumericState class.

Constructor Detail

IltBooleanState

public IltBooleanState(String name,
                       String description,
                       String message,
                       boolean defaultValue)

Creates an IltBooleanState.

Parameters:

description - textual description of this state.

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

IltBooleanState

public IltBooleanState(String name,
                       String description,
                       String message)

Creates an IltBooleanState.

Parameters:

description - textual description of this state.

Method Detail

isValid

public boolean isValid(Object value)

This method verifies if the given value can be set in the state. If the value is valid, this method returns true.

Overrides:

isValid in class IltState

list

public void list(IlpContext context,
                 IltStateListing listing,
                 Object value)

Generates a plain text listing of a state. The text is generated when the value of the state is true.

Overrides:

list in class IltState