Package org.gnome.gtk

Enum Class SorterOrder

java.lang.Object

java.lang.Enum<SorterOrder>

org.gnome.gtk.SorterOrder

All Implemented Interfaces:

Serializable, Comparable<SorterOrder>, Constable, Enumeration

@Generated("io.github.jwharm.JavaGI")
public enum SorterOrder
extends Enum<SorterOrder>
implements Enumeration

Describes the type of order that a GtkSorter may produce.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	No order, all elements are considered equal.
PARTIAL	A partial order.
TOTAL	A total order.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the SorterOrder class
int	getValue()	Get the numeric value of this enum
static SorterOrder	of(int value)	Create a new SorterOrder for the provided value
static SorterOrder	of(MemorySegment address)	Create a new SorterOrder for the value in the provided memory address.
static SorterOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SorterOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PARTIAL

public static final SorterOrder PARTIAL

A partial order. Any GtkOrdering is possible.

NONE

public static final SorterOrder NONE

No order, all elements are considered equal. gtk_sorter_compare() will only return Ordering.EQUAL.

TOTAL

public static final SorterOrder TOTAL

A total order. gtk_sorter_compare() will only return Ordering.EQUAL if an item is compared with itself. Two different items will never cause this value to be returned.

Method Details

values

public static SorterOrder[] 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 SorterOrder 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

of

public static SorterOrder of(int value)

Create a new SorterOrder for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static SorterOrder of(MemorySegment address)

Create a new SorterOrder for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the SorterOrder class

Returns:

the GType