Package nl.esciencecenter.xenon.filesystems

Enum PosixFilePermission

java.lang.Object

java.lang.Enum<PosixFilePermission>

nl.esciencecenter.xenon.filesystems.PosixFilePermission

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PosixFilePermission>

public enum PosixFilePermission
extends java.lang.Enum<PosixFilePermission>

PosixFilePermission is an enumeration containing all supported Posix file permissions.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
GROUP_EXECUTE	Execute/search permission, group.
GROUP_READ	Read permission, group.
GROUP_WRITE	Write permission, group.
OTHERS_EXECUTE	Execute/search permission, others.
OTHERS_READ	Read permission, others.
OTHERS_WRITE	Write permission, others.
OWNER_EXECUTE	Execute/search permission, owner.
OWNER_READ	Read permission, owner.
OWNER_WRITE	Write permission, owner.

Method Summary

Modifier and Type	Method	Description
static boolean	contains(PosixFilePermission toFind, PosixFilePermission... options)	Check if a sequence of PosixFilePermissions contains a specific option.
static java.util.Set<PosixFilePermission>	convertFromOctal(java.lang.String octal)
static java.lang.String	convertToOctal(java.util.Set<PosixFilePermission> permissions)
static PosixFilePermission	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PosixFilePermission[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GROUP_EXECUTE

public static final PosixFilePermission GROUP_EXECUTE

Execute/search permission, group.

GROUP_READ

public static final PosixFilePermission GROUP_READ

Read permission, group.

GROUP_WRITE

public static final PosixFilePermission GROUP_WRITE

Write permission, group.

OTHERS_EXECUTE

public static final PosixFilePermission OTHERS_EXECUTE

Execute/search permission, others.

OTHERS_READ

public static final PosixFilePermission OTHERS_READ

Read permission, others.

OTHERS_WRITE

public static final PosixFilePermission OTHERS_WRITE

Write permission, others.

OWNER_EXECUTE

public static final PosixFilePermission OWNER_EXECUTE

Execute/search permission, owner.

OWNER_READ

public static final PosixFilePermission OWNER_READ

Read permission, owner.

OWNER_WRITE

public static final PosixFilePermission OWNER_WRITE

Write permission, owner.

Method Detail

values

public static PosixFilePermission[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PosixFilePermission c : PosixFilePermission.values())
    System.out.println(c);

Returns:

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

valueOf

public static PosixFilePermission valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

contains

public static boolean contains(PosixFilePermission toFind,
                               PosixFilePermission... options)

Check if a sequence of PosixFilePermissions contains a specific option. If option or options is null, false will be returned.

Parameters:

toFind - the option to find.

options - the options to check.

Returns:

if options contains option.

convertToOctal

public static java.lang.String convertToOctal(java.util.Set<PosixFilePermission> permissions)

convertFromOctal

public static java.util.Set<PosixFilePermission> convertFromOctal(java.lang.String octal)