ilog.tgo.model

Class IltSymbolicState

java.lang.Object

ilog.tgo.model.IltState

ilog.tgo.model.IltSimpleState

ilog.tgo.model.IltSymbolicState

All Implemented Interfaces:

IltDecorationSource, IlWithProperties, Cloneable

Direct Known Subclasses:

IltBellcore.SecState, IltBellcore.State, IltMisc.SecState, IltOSI.Availability, IltOSI.Control, IltOSI.Procedural, IltOSI.Repair, IltOSI.Standby, IltOSI.State.Administrative, IltOSI.State.Operational, IltOSI.State.Usage, IltSNMP.State, IltSONET.Protection, IltSONET.State

public class IltSymbolicState
extends IltSimpleState
implements Cloneable

This class is the base class for all classes defining symbolic values, to be used as vocabulary in an object's state.

When creating a subclass of IltSymbolicState, you have to statically allocate a new IltStateInfo instance for it; by convention this is assigned to a variable called metainfo.

See Also:

IltStateInfo

Field Summary

Fields

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

Fields inherited from class ilog.tgo.model.IltState

_message

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltSymbolicState()
	IltSymbolicState(String name, String description, String message, IltSymbolicStateValue defaultValue) Creates an IltSymbolicState with a description and a default value.

Method Summary

Modifier and Type	Method and Description
void	add(IltSymbolicStateValue newValue) Add a new value to this symbolic state.
Object	clone() Returns this object.
String	getName() Returns the name of this symbolic value.
String	getToolTipText(IlpContext context, IltObject obj) Returns a description of the state.
String	getToolTipText(IltObject obj) Deprecated.
IltSymbolicStateValue	getValue(String name) Returns a possible value from a name
IltSymbolicStateValue[]	getValues() Return the possible values for this symbolic state.
boolean	has(IltSymbolicStateValue value) Returns true if the value is present in the list of possible values.
boolean	isValid(Object value) Returns if the given value is valid for this state.
void	list(IlpContext context, IltStateListing listing, Object value) Generates a plain text listing of a state.
void	remove(IltSymbolicStateValue value) Remove a value from this symbolic state.
void	setName(String name) Sets the name of this symbolic value.
void	setValues(IltSymbolicStateValue[] newValues) Set the possible values for this symbolic state.
Enumeration	values() Return the possible values for this 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, getProperty, getStateInfo, hasDescription, hashCode, intern, isInside, IsPropertyTransient, removeProperty, setAltName, setDescription, setMessage, setProperty, SetPropertyTransient, toString

Methods inherited from class java.lang.Object

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

Field Detail

metainfo

public static IltStateInfo metainfo

Contains metainformation about this IltState class.

Internal: do not use!

Constructor Detail

IltSymbolicState

protected IltSymbolicState()

Internal: do not use!

IltSymbolicState

public IltSymbolicState(String name,
                        String description,
                        String message,
                        IltSymbolicStateValue defaultValue)

Creates an IltSymbolicState with a description and a default value.

Parameters:

name - identifier of the state, used for serialization

description - textual description of this state.

message - catalog message representing this state.

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

Internal: do not use!

Method Detail

getName

public String getName()

Returns the name of this symbolic value.

Overrides:

getName in class IltState

setName

public void setName(String name)

Sets the name of this symbolic value. This method is used by CSS styling mechanism and is not meant to be called directly.

Overrides:

setName in class IltState

Internal: do not use!

add

public void add(IltSymbolicStateValue newValue)

Add a new value to this symbolic state.

Internal: do not use!

remove

public void remove(IltSymbolicStateValue value)

Remove a value from this symbolic state.

Internal: do not use!

has

public boolean has(IltSymbolicStateValue value)

Returns true if the value is present in the list of possible values.

Internal: do not use!

getValue

public IltSymbolicStateValue getValue(String name)

Returns a possible value from a name

Internal: do not use!

values

public Enumeration values()

Return the possible values for this state.

Internal: do not use!

getValues

public IltSymbolicStateValue[] getValues()

Return the possible values for this symbolic state. This method returns null if there are no values for this state.

Internal: do not use!

setValues

public void setValues(IltSymbolicStateValue[] newValues)

Set the possible values for this symbolic state.

Internal: do not use!

isValid

public boolean isValid(Object value)

Returns if the given value is valid for this state.

Overrides:

isValid in class IltState

Internal: do not use!

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

Internal: do not use!

getToolTipText

@Deprecated
public String getToolTipText(IltObject obj)

Deprecated.

Returns a description of the state.

Specified by:

getToolTipText in interface IltDecorationSource

Overrides:

getToolTipText in class IltState

Internal: do not use!

Deprecated Since:

JTGO 3.1

getToolTipText

public String getToolTipText(IlpContext context,
                             IltObject obj)

Returns a description of the state.

Specified by:

getToolTipText in interface IltDecorationSource

Overrides:

getToolTipText in class IltState

Internal: do not use!

clone

public Object clone()

Returns this object.

Overrides:

clone in class Object

Internal: do not use!