com.yworks.yfiles.utils

Class FlagsEnum<T extends FlagsEnum>

java.lang.Object

java.lang.Number

com.yworks.yfiles.utils.FlagsEnum<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdjacencyTypes, ComponentArrangementStyles, DiscreteEdgeLabelPositions, DiscreteNodeLabelPositions, DragDropKeyStates, EdgeBundleModes, EdgeSides, GraphClipboard.ParentNodeDetectionModes, GraphCopier.CloneTypes, GraphItemTypes, GridSnapTypes, HandlePositions, HandleTypes, InertiaPolicies, LabelAngleOnRightSideOffsets, LabelAngleOnRightSideRotations, LabelAngleReferences, LabelPlacements, LabelSideReferences, MirrorModes, ModifierKeys, MouseButtons, MouseWheelBehaviors, MoveTypes, PortDirections, SnapLineSnapTypes, SnapTypes, StripeSubregionTypes, StripeTypes

public abstract class FlagsEnum<T extends FlagsEnum>
extends Number

An enumerable that represents a collection of flags, rather than a single value. Such a collection can be manipulated and combined using bitwise operations.

Practically, a FlagsEnum collections consists of a number of constant FlagsEnums. Those are pairs of an integer ordinal number and a string identifier.

Example
This example for FlagsEnum generates the logical equalities.

 Predefined constants:
 Ordinal - Flag Name

       0 - Black
       1 - Red
       2 - Green
       4 - Blue

 All possible combinations of values of those constants produced by bitwise operations:

       0 - Black
       1 - Red
       2 - Green
       3 - Red, Green
       4 - Blue
       5 - Red, Blue
       6 - Green, Blue
       7 - Red, Green, Blue
 

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlagsEnum(int ordinal, String name)

Method Summary

Modifier and Type	Method and Description
T	and(T other) Logically combines this FlagsEnum with another FlagsEnum to create a new instance that is equal to the original FlagsEnum AND the other FlagsEnum.
static <T extends FlagsEnum<T>> T	and(T t1, T t2) Static convenience method that is semantically identical to the non-static method and(FlagsEnum)
boolean	contains(FlagsEnum<T> other) Determines whether any flag in other is also contained in this instance.
boolean	containsAll(FlagsEnum<T> other) Determines whether all flags in other are also contained in this instance.
double	doubleValue()
boolean	equals(Object o)
static <T extends FlagsEnum<T>> boolean	equals(T t1, T t2)
float	floatValue()
protected abstract T	fromOrdinalImpl(int ordinal)
protected abstract T[]	getItems() Returns all items defined in this FlagsEnum.
int	hashCode()
int	intValue()
T	inverse() Returns a FlagsEnum that is the inverse to this FlagsEnum.
static <T extends FlagsEnum<T>> T	inverse(T t) Static convenience method that is semantically identical to the non-static method inverse()
long	longValue()
boolean	notContains(FlagsEnum<T> other) Determines whether none of the flags in other are also contained in this instance.
static <T extends FlagsEnum<T>> boolean	notEquals(T t1, T t2)
T	or(T other) Logically combines this FlagsEnum with another FlagsEnum to create a new instance that is equal to the original FlagsEnum OR the other FlagsEnum.
static <T extends FlagsEnum<T>> T	or(T t1, T t2) Static convenience method that is semantically identical to the non-static method or(FlagsEnum)
int	ordinal() Returns the integer ordinal number for this flag.
String	toString()
T	xor(T other) Logically combines this FlagsEnum with another FlagsEnum to create a new instance that is equal to the original FlagsEnum XOR the other FlagsEnum.
static <T extends FlagsEnum<T>> T	xor(T t1, T t2) Static convenience method that is semantically identical to the non-static method xor(FlagsEnum)

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

FlagsEnum

protected FlagsEnum(int ordinal,
                    String name)

Method Detail

and

public final T and(T other)

Logically combines this FlagsEnum with another FlagsEnum to create a new instance that is equal to the original FlagsEnum AND the other FlagsEnum.

Parameters:

other - Another FlagsEnum.

Returns:

A new FlagsEnum that is equal to the original FlagsEnum AND the other FlagsEnum.

and

public static final <T extends FlagsEnum<T>> T and(T t1,
                                                   T t2)

Static convenience method that is semantically identical to the non-static method and(FlagsEnum)

contains

public final boolean contains(FlagsEnum<T> other)

Determines whether any flag in other is also contained in this instance.

Returns:

true if any flag in other is also contained in this instance; otherwise, false.

containsAll

public final boolean containsAll(FlagsEnum<T> other)

Determines whether all flags in other are also contained in this instance.

Returns:

true if all flags in other are also contained in this instance; otherwise, false.

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public static final <T extends FlagsEnum<T>> boolean equals(T t1,
                                                            T t2)

floatValue

public float floatValue()

Specified by:

floatValue in class Number

fromOrdinalImpl

protected abstract T fromOrdinalImpl(int ordinal)

getItems

protected abstract T[] getItems()

Returns all items defined in this FlagsEnum.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Specified by:

intValue in class Number

inverse

public final T inverse()

Returns a FlagsEnum that is the inverse to this FlagsEnum.

inverse

public static final <T extends FlagsEnum<T>> T inverse(T t)

Static convenience method that is semantically identical to the non-static method inverse()

longValue

public long longValue()

Specified by:

longValue in class Number

notContains

public final boolean notContains(FlagsEnum<T> other)

Determines whether none of the flags in other are also contained in this instance.

Returns:

true if none of the flags in other are also contained in this instance; otherwise, false.

notEquals

public static final <T extends FlagsEnum<T>> boolean notEquals(T t1,
                                                               T t2)

or

public final T or(T other)

Logically combines this FlagsEnum with another FlagsEnum to create a new instance that is equal to the original FlagsEnum OR the other FlagsEnum.

Parameters:

other - Another FlagsEnum.

Returns:

A new FlagsEnum that is equal to the original FlagsEnum OR the other FlagsEnum.

or

public static final <T extends FlagsEnum<T>> T or(T t1,
                                                  T t2)

Static convenience method that is semantically identical to the non-static method or(FlagsEnum)

ordinal

public final int ordinal()

Returns the integer ordinal number for this flag.

toString

public String toString()

Overrides:

toString in class Object

xor

public final T xor(T other)

Logically combines this FlagsEnum with another FlagsEnum to create a new instance that is equal to the original FlagsEnum XOR the other FlagsEnum.

Parameters:

other - Another FlagsEnum.

Returns:

A new FlagsEnum that is equal to the original FlagsEnum XOR the other FlagsEnum.

xor

public static final <T extends FlagsEnum<T>> T xor(T t1,
                                                   T t2)

Static convenience method that is semantically identical to the non-static method xor(FlagsEnum)