|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--fipaos.util.FlagHandler
FlagHandler provides an easy method of using bitwise flags to store state, minimising the use of multiple booleans for state management. FlagHandler is thread safe - no race conditions can occur when accessing the same FlagHandler from multiple threads.
Constructor Summary | |
FlagHandler()
Constructs an empty FlagHandler - there are intially no flags set or known about. |
Method Summary | |
boolean |
addFlag(java.lang.String flag)
Add a new flag to the handler. |
boolean |
addFlag(java.lang.String flag,
java.lang.String mxflag)
Add a new flag to the handler. |
boolean |
addFlag(java.lang.String flag,
java.lang.String[] mxflags)
Add a new flag to the handler. |
void |
clearAllFlags()
Sets all of the flags to false (clears every flag); |
void |
clearFlag(java.lang.String flag)
Clears a flag (set it to false). |
boolean |
containsFlag(java.lang.String flag)
Checks to see if this handler contains the specified flag. |
int |
getNumberOfFlags()
Returns the number of flags currently being handled. |
void |
setFlag(java.lang.String flag)
Sets a flag to true, and sets any mutually exclusive flags to false. |
void |
setMutualExclusions(java.lang.String flag,
java.lang.String[] mxflags)
Adds a set of mutually exclusive flag markers to the specified flag. |
boolean |
testFlag(java.lang.String flag)
Tests the value of the flag. |
void |
toggleFlag(java.lang.String flag)
Toggles the value of the flag, clearing any mutually exclusive flags if this flag is set. |
java.lang.String |
toString()
Returns a string based representation of the status of every flag in the handler. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public FlagHandler()
Method Detail |
public boolean addFlag(java.lang.String flag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.public boolean addFlag(java.lang.String flag, java.lang.String mxflag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.mxflag
- Another flag that this flag is mutually exclusive withpublic boolean addFlag(java.lang.String flag, java.lang.String[] mxflags)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.mxflags
- An array of mutually exclusive flagspublic void setFlag(java.lang.String flag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.public void clearFlag(java.lang.String flag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.public boolean testFlag(java.lang.String flag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.public void toggleFlag(java.lang.String flag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.public boolean containsFlag(java.lang.String flag)
flag
- The flag name as a String. Flags are always referenced by string to ease
programmer effort.public void clearAllFlags()
public int getNumberOfFlags()
public void setMutualExclusions(java.lang.String flag, java.lang.String[] mxflags)
flag
- The flag to add tomxflags
- The mutually exclusive flag namespublic java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |