Package org.gnome.glib

Enum Class UserDirectory

java.lang.Object

java.lang.Enum<UserDirectory>

org.gnome.glib.UserDirectory

All Implemented Interfaces:

Enumeration, Serializable, Comparable<UserDirectory>, Constable

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

These are logical ids for special directories which are defined depending on the platform used. You should use g_get_user_special_dir() to retrieve the full path associated to the logical id.

The GUserDirectory enumeration can be extended at later date. Not every platform has a directory for every logical id in this enumeration.

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
DIRECTORY_DESKTOP	the user's Desktop directory
DIRECTORY_DOCUMENTS	the user's Documents directory
DIRECTORY_DOWNLOAD	the user's Downloads directory
DIRECTORY_MUSIC	the user's Music directory
DIRECTORY_PICTURES	the user's Pictures directory
DIRECTORY_PUBLIC_SHARE	the user's shared directory
DIRECTORY_TEMPLATES	the user's Templates directory
DIRECTORY_VIDEOS	the user's Movies directory
N_DIRECTORIES	the number of enum values

Method Summary

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

DIRECTORY_DESKTOP

public static final UserDirectory DIRECTORY_DESKTOP

the user's Desktop directory

DIRECTORY_DOCUMENTS

public static final UserDirectory DIRECTORY_DOCUMENTS

the user's Documents directory

DIRECTORY_DOWNLOAD

public static final UserDirectory DIRECTORY_DOWNLOAD

the user's Downloads directory

DIRECTORY_MUSIC

public static final UserDirectory DIRECTORY_MUSIC

the user's Music directory

DIRECTORY_PICTURES

public static final UserDirectory DIRECTORY_PICTURES

the user's Pictures directory

DIRECTORY_PUBLIC_SHARE

public static final UserDirectory DIRECTORY_PUBLIC_SHARE

the user's shared directory

DIRECTORY_TEMPLATES

public static final UserDirectory DIRECTORY_TEMPLATES

the user's Templates directory

DIRECTORY_VIDEOS

public static final UserDirectory DIRECTORY_VIDEOS

the user's Movies directory

N_DIRECTORIES

public static final UserDirectory N_DIRECTORIES

the number of enum values

Method Details

values

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

Create a new UserDirectory 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