Class Flags
java.lang.Object
org.apache.commons.validator.util.Flags
- All Implemented Interfaces:
Serializable,Cloneable
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
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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Turn off all flags.clone()Clone this Flags object.booleanTests if two Flags objects are in the same state.longgetFlags()Returns the current flags.inthashCode()The hash code is based on the current state of the flags.booleanisOff(long flag) Tests whether the given flag is off.booleanisOn(long flag) Tests whether the given flag is on.toString()Returns a 64 length String with the first flag on the right and the 64th flag on the left.voidturnOff(long flag) Turns off the given flag.voidTurn off all flags.voidturnOn(long flag) Turns on the given flag.voidTurn on all 64 flags.
-
Constructor Details
-
Flags
public Flags()Create a new Flags object. -
Flags
Initialize a new Flags object with the given flags.- Parameters:
flags- collection of boolean flags to represent.
-
-
Method Details
-
clear
Turn off all flags. This is a synonym forturnOffAll().- Since:
- 1.1.1
-
clone
Clone this Flags object. -
equals
Tests if two Flags objects are in the same state. -
getFlags
Returns the current flags.- Returns:
- collection of boolean flags represented.
-
hashCode
The hash code is based on the current state of the flags. -
isOff
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.- Parameters:
flag- Flag value to check.- Returns:
- whether the specified flag value is off.
-
isOn
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.- Parameters:
flag- Flag value to check.- Returns:
- whether the specified flag value is on.
-
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. -
turnOff
Turns off the given flag. If the flag is not a power of 2 (ie. 3) this turns off multiple flags.- Parameters:
flag- Flag value to turn off.
-
turnOffAll
Turn off all flags. -
turnOn
Turns on the given flag. If the flag is not a power of 2 (ie. 3) this turns on multiple flags.- Parameters:
flag- Flag value to turn on.
-
turnOnAll
Turn on all 64 flags.
-