Enum Class TraverseFlags

java.lang.Object

java.lang.Enum<TraverseFlags>

org.gnome.glib.TraverseFlags

All Implemented Interfaces:

Serializable, Comparable<TraverseFlags>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum TraverseFlags
extends Enum<TraverseFlags>
implements Enumeration

Specifies which nodes are visited during several of the tree functions, including g_node_traverse() and g_node_find().

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	all nodes should be visited.
LEAVES	only leaf nodes should be visited.
NON_LEAVES	only non-leaf nodes should be visited.

Field Summary

Fields

Modifier and Type	Field	Description
static final TraverseFlags	LEAFS	identical to LEAVES.
static final TraverseFlags	MASK	a mask of all traverse flags.
static final TraverseFlags	NON_LEAFS	identical to NON_LEAVES.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Get the numeric value of this enum
static Set<TraverseFlags>	of(int flags)	Create a new EnumSet<TraverseFlags> for the provided bitfield
static Set<TraverseFlags>	of(MemorySegment address)	Create a new EnumSet<TraverseFlags> for the bitfield in the provided memory address.
static TraverseFlags	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TraverseFlags[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEAVES

public static final TraverseFlags LEAVES

only leaf nodes should be visited. This name has been introduced in 2.6, for older version use LEAFS.

NON_LEAVES

public static final TraverseFlags NON_LEAVES

only non-leaf nodes should be visited. This name has been introduced in 2.6, for older version use NON_LEAFS.

ALL

public static final TraverseFlags ALL

all nodes should be visited.

Field Details

MASK

public static final TraverseFlags MASK

a mask of all traverse flags.

LEAFS

public static final TraverseFlags LEAFS

identical to LEAVES.

NON_LEAFS

public static final TraverseFlags NON_LEAFS

identical to NON_LEAVES.

Method Details

values

public static TraverseFlags[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TraverseFlags valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static Set<TraverseFlags> of(int flags)

Create a new EnumSet<TraverseFlags> for the provided bitfield

Parameters:

flags - the TraverseFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<TraverseFlags> of(MemorySegment address)

Create a new EnumSet<TraverseFlags> for the bitfield in the provided memory address.

Parameters:

address - the memory address holding a bitfield value

Returns:

the EnumSet for the bitfield in the provided memory address