org.apache.commons.validator.util
Class Flags
public
class
Flags
extends Object
implements Serializable
Represents a collection of 64 boolean (on/off) flags. Individual flags
are represented by powers of 2. For example,
Flag 1 = 1
Flag 2 = 2
Flag 3 = 4
Flag 4 = 8
or using shift operator to make numbering easier:
Flag 1 = 1 << 0
Flag 2 = 1 << 1
Flag 3 = 1 << 2
Flag 4 = 1 << 3
There cannot be a flag with a value of 3 because that represents Flag 1
and Flag 2 both being on/true.
Method Summary |
void | clear()
Turn off all flags. |
Object | clone()
Clone this Flags object. |
boolean | equals(Object obj)
Tests if two Flags objects are in the same state. |
long | getFlags()
Returns the current flags. |
int | hashCode()
The hash code is based on the current state of the flags. |
boolean | isOff(long flag)
Tests whether the given flag is off. |
boolean | isOn(long flag)
Tests whether the given flag is on. |
String | toString()
Returns a 64 length String with the first flag on the right and the
64th flag on the left. |
void | turnOff(long flag)
Turns off the given flag. |
void | turnOffAll()
Turn off all flags. |
void | turnOn(long flag)
Turns on the given flag. |
void | turnOnAll()
Turn on all 64 flags. |
private long flags
Represents the current flag state.
public Flags()
Create a new Flags object.
public Flags(long flags)
Initialize a new Flags object with the given flags.
public void clear()
Turn off all flags. This is a synonym for
turnOffAll()
.
Since: Validator 1.1.1
public Object clone()
Clone this Flags object.
See Also: java.lang.Object#clone()
public boolean equals(Object obj)
Tests if two Flags objects are in the same state.
Parameters: obj object being tested
See Also: java.lang.Object#equals(java.lang.Object)
public long getFlags()
Returns the current flags.
public int hashCode()
The hash code is based on the current state of the flags.
See Also: java.lang.Object#hashCode()
public boolean isOff(long flag)
Tests whether the given flag is off. If the flag is not a power of 2
(ie. 3) this tests whether the combination of flags is off.
public boolean isOn(long flag)
Tests whether the given flag is on. If the flag is not a power of 2
(ie. 3) this tests whether the combination of flags is on.
public String toString()
Returns a 64 length String with the first flag on the right and the
64th flag on the left. A 1 indicates the flag is on, a 0 means it's
off.
public void turnOff(long flag)
Turns off the given flag. If the flag is not a power of 2 (ie. 3) this
turns off multiple flags.
public void turnOffAll()
Turn off all flags.
public void turnOn(long flag)
Turns on the given flag. If the flag is not a power of 2 (ie. 3) this
turns on multiple flags.
public void turnOnAll()
Turn on all 64 flags.
Copyright (c) 2001-2004 Apache Software Foundation