net.adamcin.oakpal.api

Enum PathAction

java.lang.Object

java.lang.Enum<PathAction>

net.adamcin.oakpal.api.PathAction

All Implemented Interfaces:

Serializable, Comparable<PathAction>

public enum PathAction
extends Enum<PathAction>

Enumeration of progress tracker path import action types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDED
DELETED
ERROR
MISSING
MODIFIED
NOOP
REPLACED
UNKNOWN

Method Summary

Modifier and Type	Method and Description
boolean	canGetItem() Returns true if it is safe to get the item at the referenced path based on this action type.
static PathAction	fromShortCode(String shortCode) Lookup an action type by the short code.
String	getShortCode() Get the short code reported by filevault.
boolean	isNoop() Returns true if this is the NOOP action type.
boolean	isUnknown() Returns true if this is the UNKNOWN fallback action type.
String	toString()
static PathAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static PathAction[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOOP

public static final PathAction NOOP

MODIFIED

public static final PathAction MODIFIED

REPLACED

public static final PathAction REPLACED

ERROR

public static final PathAction ERROR

ADDED

public static final PathAction ADDED

DELETED

public static final PathAction DELETED

MISSING

public static final PathAction MISSING

UNKNOWN

public static final PathAction UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static PathAction valueOf(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:

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

NullPointerException - if the argument is null

getShortCode

public String getShortCode()

Get the short code reported by filevault.

Returns:

the action type short code

isNoop

public boolean isNoop()

Returns true if this is the NOOP action type.

Returns:

true if noop

isUnknown

public boolean isUnknown()

Returns true if this is the UNKNOWN fallback action type. This type may be reported in the future if a new filevault action code is introduced that isn't recognized by oakpal.

Returns:

true if unknown action type

canGetItem

public boolean canGetItem()

Returns true if it is safe to get the item at the referenced path based on this action type.

Returns:

true if safe to get item from session

toString

public String toString()

Overrides:

toString in class Enum<PathAction>

fromShortCode

public static PathAction fromShortCode(String shortCode)

Lookup an action type by the short code.

Parameters:

shortCode - the short code

Returns:

the representative action type or UNKNOWN