gumbo.util.state
Class StateFlag

java.lang.Object
  |
  +--gumbo.util.state.StateFlag

Direct Known Subclasses:

ActionFlag, ControlFlag, Inputs.Flag, ObjectFlag, StatusFlag, TypeFlag

public class StateFlag

extends java.lang.Object

An abstract convenience class for immutable state flags in a state value. State flags can be used to indicate state, and to specify it. State flag identity (equals(), hashCode()) defaults to that of Object, which uses "reference" equivalency. The flag name is not a factor in the flag's identity.

Version:

$Revision: 1.2 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Constructor Summary

StateFlag()
Constructs an instance, with a default name.

StateFlag(java.lang.String name)
Constructs an instance, with the specified name.

Method Summary

java.lang.String	getName() Returns the name of this flag.
java.lang.String	toString() Returns the name of this flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

StateFlag

public StateFlag()

Constructs an instance, with a default name.

StateFlag

public StateFlag(java.lang.String name)

Constructs an instance, with the specified name. Master constructor.

Parameters:

name - Name of this state flag. If null, defaults to "StateFlag".

Method Detail

getName

public final java.lang.String getName()

Returns the name of this flag. Never null.

toString

public java.lang.String toString()

Returns the name of this flag. Never null.

Overrides:

toString in class java.lang.Object