Enum Class Collation

java.lang.Object

java.lang.Enum<Collation>

org.gnome.gtk.Collation

All Implemented Interfaces:

Serializable, Comparable<Collation>, Constable, Enumeration

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

Describes how a StringSorter turns strings into sort keys to compare them.

Note that the result of sorting will in general depend on the current locale unless the mode is GTKCOLLATIONNONE.

Since:

4.10

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILENAME	Use GLib#utf8CollateKeyForFilename
NONE	Don't do any collation
UNICODE	Use GLib#utf8CollateKey

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the Collation class.
int	getValue()	Get the numeric value of this enum
static Collation	of(int value)	Create a new Collation for the provided value
static Collation	of(MemorySegment address)	Create a new Collation for the value in the provided memory address.
static Collation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Collation[]	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

NONE

public static final Collation NONE

Don't do any collation

UNICODE

public static final Collation UNICODE

Use GLib#utf8CollateKey

FILENAME

public static final Collation FILENAME

Use GLib#utf8CollateKeyForFilename

Method Details

values

public static Collation[] 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 Collation 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 Collation of(int value)

Create a new Collation 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 Collation of(MemorySegment address)

Create a new Collation 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 Collation class.

Returns:

the GType