Package com.inductiveautomation.ignition.common.util

Class Flags

java.lang.Object

com.inductiveautomation.ignition.common.util.Flags

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AlarmEvalState, RuntimeQuality, TagProviderAttributes

public class Flags
extends java.lang.Object
implements java.io.Serializable

General purpose wrapper around an int that lets you easily work with numeric flags.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Flags()
Flags(int... flags)

Method Summary

Modifier and Type	Method	Description
Flags	and(int... flags)
Flags	and(Flags other)
Flags	clone()
static Flags	createFromValue(int flagValue)
boolean	equals(java.lang.Object obj)
Flags	except(int... flags)	Removes the provided flags from the current value.
int	getRawValue()
boolean	hasFlag(int flag)
static boolean	hasFlag(int value, int flag)
static Flags	none()
static Flags	of(int... flags)
Flags	or(int... flags)
Flags	or(Flags other)
int	rawValue()
Flags	setFlag(int flag, boolean on)
static int	setFlag(int value, int flag, boolean on)
void	setRawValue(int value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Flags

public Flags()

Flags

public Flags(int... flags)

Method Detail

createFromValue

public static Flags createFromValue(int flagValue)

of

public static Flags of(int... flags)

none

public static Flags none()

hasFlag

public boolean hasFlag(int flag)

hasFlag

public static boolean hasFlag(int value,
                              int flag)

setFlag

public static int setFlag(int value,
                          int flag,
                          boolean on)

setFlag

public Flags setFlag(int flag,
                     boolean on)

and

public Flags and(Flags other)

and

public Flags and(int... flags)

or

public Flags or(Flags other)

or

public Flags or(int... flags)

except

public Flags except(int... flags)

Removes the provided flags from the current value.

rawValue

public int rawValue()

getRawValue

public int getRawValue()

setRawValue

public void setRawValue(int value)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public Flags clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object