Package org.apache.hadoop.fs.permission

Enum FsAction

java.lang.Object

java.lang.Enum<FsAction>

org.apache.hadoop.fs.permission.FsAction

All Implemented Interfaces:

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

@Public
@Stable
public enum FsAction
extends java.lang.Enum<FsAction>

File system actions, e.g. read, write, etc.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
EXECUTE
NONE
READ
READ_EXECUTE
READ_WRITE
WRITE
WRITE_EXECUTE

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	SYMBOL	Symbolic representation

Method Summary

Modifier and Type	Method	Description
FsAction	and(FsAction that)	AND operation.
static FsAction	getFsAction(java.lang.String permission)	Get the FsAction enum for String representation of permissions
boolean	implies(FsAction that)	Return true if this action implies that action.
FsAction	not()	NOT operation.
FsAction	or(FsAction that)	OR operation.
static FsAction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static FsAction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FsAction NONE

EXECUTE

public static final FsAction EXECUTE

WRITE

public static final FsAction WRITE

WRITE_EXECUTE

public static final FsAction WRITE_EXECUTE

READ

public static final FsAction READ

READ_EXECUTE

public static final FsAction READ_EXECUTE

READ_WRITE

public static final FsAction READ_WRITE

ALL

public static final FsAction ALL

Field Detail

SYMBOL

public final java.lang.String SYMBOL

Symbolic representation

Method Detail

values

public static FsAction[] 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 (FsAction c : FsAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static FsAction 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

implies

public boolean implies(FsAction that)

Return true if this action implies that action.

Parameters:

that - FsAction that.

Returns:

if implies true,not false.

and

public FsAction and(FsAction that)

AND operation.

Parameters:

that - FsAction that.

Returns:

FsAction.

or

public FsAction or(FsAction that)

OR operation.

Parameters:

that - FsAction that.

Returns:

FsAction.

not

public FsAction not()

NOT operation.

Returns:

FsAction.

getFsAction

public static FsAction getFsAction(java.lang.String permission)

Get the FsAction enum for String representation of permissions

Parameters:

permission - 3-character string representation of permission. ex: rwx

Returns:

Returns FsAction enum if the corresponding FsAction exists for permission. Otherwise returns null