Package org.gnome.gobject

Enum Class ParamFlags

java.lang.Object

java.lang.Enum<ParamFlags>

org.gnome.gobject.ParamFlags

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ParamFlags>, Constable

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

Through the GParamFlags flag values, certain aspects of parameters can be configured.

See also: G_PARAM_STATIC_STRINGS

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
CONSTRUCT	the parameter will be set upon object construction
CONSTRUCT_ONLY	the parameter can only be set upon object construction
DEPRECATED	the parameter is deprecated and will be removed in a future version.
EXPLICIT_NOTIFY	calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves in case the property actually changes.
LAX_VALIDATION	upon parameter conversion (see g_param_value_convert()) strict validation is not required
READABLE	the parameter is readable
READWRITE	alias for READABLE | WRITABLE
STATIC_BLURB	the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter.
STATIC_NAME	the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter.
STATIC_NICK	the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter.
WRITABLE	the parameter is writable

Field Summary

Fields

Modifier and Type	Field	Description
static final ParamFlags	PRIVATE	internal

Method Summary

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

READABLE

public static final ParamFlags READABLE

the parameter is readable

WRITABLE

public static final ParamFlags WRITABLE

the parameter is writable

READWRITE

public static final ParamFlags READWRITE

alias for READABLE | WRITABLE

CONSTRUCT

public static final ParamFlags CONSTRUCT

the parameter will be set upon object construction

CONSTRUCT_ONLY

public static final ParamFlags CONSTRUCT_ONLY

the parameter can only be set upon object construction

LAX_VALIDATION

public static final ParamFlags LAX_VALIDATION

upon parameter conversion (see g_param_value_convert()) strict validation is not required

STATIC_NAME

public static final ParamFlags STATIC_NAME

the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8

STATIC_NICK

public static final ParamFlags STATIC_NICK

the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter. Since 2.8

STATIC_BLURB

public static final ParamFlags STATIC_BLURB

the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. Since 2.8

EXPLICIT_NOTIFY

public static final ParamFlags EXPLICIT_NOTIFY

calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves in case the property actually changes. Since: 2.42.

DEPRECATED

public static final ParamFlags DEPRECATED

the parameter is deprecated and will be removed in a future version. A warning will be generated if it is used while running with G_ENABLE_DIAGNOSTIC=1. Since 2.26

Field Details

PRIVATE

public static final ParamFlags PRIVATE

internal

Method Details

values

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

Create a new ParamFlags for the provided value

Parameters:

value - the bitfield value

Returns:

the bitfield 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