ilog.tgo.model

Class IltStateInfo

java.lang.Object

ilog.tgo.model.IltStateInfo

public class IltStateInfo
extends Object

Each IltStateInfo instance describes a subclass of IltState.

See Also:

IltState

Constructor Summary

Constructors

Constructor and Description
IltStateInfo(Class clazz, String description) Creates the descriptor of an IltState subclass.

Method Summary

Modifier and Type	Method and Description
void	addState(IltState state) Registers a new state.
static Enumeration	AllStateInfos() Returns an enumeration of all existing states infos.
static IltStateInfo	FromClass(Class clazz) Returns the class information for a state, given its class.
Class	getDefiningClass() Returns the state, a subclass of IltState.
String	getDescription() Returns a description of the state.
IltStateInfo	getParent() Returns the parent class descriptor.
IltState	getState(String name) Returns the state that corresponds to the given name.
boolean	hasState(IltState state) Tests whether a given state is registered.
IltState	intern(IltState state) Returns a canonical representation for an IltState instance.
boolean	isInside(IltStateInfo superclass) Tests whether this IltStateInfo describes a class that inherits (directly or indirectly) from the class described by a given IltStateInfo.
void	removeState(IltState state) Deregisters a state.
Enumeration	states()
String	toString() Returns the String representation of this IltStateInfo's values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IltStateInfo

public IltStateInfo(Class clazz,
                    String description)

Creates the descriptor of an IltState subclass. By convention, this descriptor is stored in a static class variable called metainfo.

Parameters:

clazz - The IltState subclass that this IltStateInfo describes.

description - Description of the state class.

Method Detail

getDefiningClass

public Class getDefiningClass()

Returns the state, a subclass of IltState.

Internal: do not use!

getDescription

public String getDescription()

Returns a description of the state.

Internal: do not use!

AllStateInfos

public static Enumeration AllStateInfos()

Returns an enumeration of all existing states infos.

Returns:

an enumeration of IltStateInfo

Internal: do not use!

FromClass

public static IltStateInfo FromClass(Class clazz)

Returns the class information for a state, given its class.

Internal: do not use!

getParent

public IltStateInfo getParent()

Returns the parent class descriptor.

Internal: do not use!

isInside

public boolean isInside(IltStateInfo superclass)

Tests whether this IltStateInfo describes a class that inherits (directly or indirectly) from the class described by a given IltStateInfo.

Internal: do not use!

hasState

public boolean hasState(IltState state)

Tests whether a given state is registered.

Internal: do not use!

getState

public IltState getState(String name)

Returns the state that corresponds to the given name.

Parameters:

name - State name

Returns:

State, if it exists, or null otherwise.

Since:

JViews 7.5

Internal: do not use!

addState

public void addState(IltState state)

Registers a new state.

Internal: do not use!

states

public Enumeration states()

Internal: do not use!

removeState

public void removeState(IltState state)

Deregisters a state.

Internal: do not use!

intern

public IltState intern(IltState state)

Returns a canonical representation for an IltState instance.

Internal: do not use!

toString

public String toString()

Returns the String representation of this IltStateInfo's values.

Overrides:

toString in class Object

Internal: do not use!