Package org.wildfly.common.format

Class NumericFlags

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.wildfly.common.flags.Flags<E,This>

org.wildfly.common.format.NumericFlags

public final class NumericFlags
extends Flags<E,This>

Field Summary

Fields

Modifier and Type	Field	Description
static NumericFlags	NONE	The empty set of numeric flags.

Method Summary

Modifier and Type	Method	Description
protected NumericFlag	castItemOrNull(java.lang.Object obj)	Get the item (cast to the correct enum type), or null if it is not of the correct type.
protected NumericFlags	castThis(java.lang.Object obj)	Cast the given object to this class, throwing an exception if the cast fails.
void	forbid(E flag)
void	forbidAll()
void	forbidAllBut(E flag)
protected NumericFlag	itemOf(int index)	Get the flag item with the given index.
static NumericFlags	of(NumericFlag flag)
static NumericFlags	of(NumericFlag flag1, NumericFlag flag2)
protected NumericFlags	this_()	Return this.
protected NumericFlags	value(int bits)	Get the set value of the given bit combination.

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, remove, retainAll

Methods inherited from class java.util.AbstractSet

removeAll

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from class org.wildfly.common.flags.Flags

comparator, complement, contains, contains, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, descendingIterator, equals, equals, equals, first, forEach, hashCode, headSet, isEmpty, iterator, last, size, subSet, tailSet, toArray, toArray, toString, with, with, with, with, with, without, without

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, remove, removeAll, retainAll

Methods inherited from interface java.util.SortedSet

spliterator

Field Detail

NONE

public static final NumericFlags NONE

The empty set of numeric flags.

Method Detail

of

public static NumericFlags of(NumericFlag flag)

of

public static NumericFlags of(NumericFlag flag1,
                              NumericFlag flag2)

this_

protected NumericFlags this_()

Description copied from class: Flags

Return this.

Specified by:

this_ in class Flags<NumericFlag,NumericFlags>

Returns:

this

value

protected NumericFlags value(int bits)

Description copied from class: Flags

Get the set value of the given bit combination. The bit combination may contain extraneous one-bits so any bits beyond the bit of the last flag should be masked off if an array is used for lookup.

Specified by:

value in class Flags<NumericFlag,NumericFlags>

Parameters:

bits - the bit combination (possibly with extra bits)

Returns:

the set instance

itemOf

protected NumericFlag itemOf(int index)

Description copied from class: Flags

Get the flag item with the given index.

Specified by:

itemOf in class Flags<NumericFlag,NumericFlags>

Parameters:

index - the index

Returns:

the flag

castItemOrNull

protected NumericFlag castItemOrNull(java.lang.Object obj)

Description copied from class: Flags

Get the item (cast to the correct enum type), or null if it is not of the correct type.

Specified by:

castItemOrNull in class Flags<NumericFlag,NumericFlags>

Parameters:

obj - the object to cast

Returns:

the cast object, or null

castThis

protected NumericFlags castThis(java.lang.Object obj)

Description copied from class: Flags

Cast the given object to this class, throwing an exception if the cast fails.

Specified by:

castThis in class Flags<NumericFlag,NumericFlags>

Parameters:

obj - the object to cast

Returns:

the cast object

forbidAll

public final void forbidAll()

forbidAllBut

public final void forbidAllBut(E flag)

forbid

public void forbid(E flag)