com.box.sdk

Enum BoxRetentionPolicy.BoxRetentionPolicyAction

Object

Enum<BoxRetentionPolicy.BoxRetentionPolicyAction>

BoxRetentionPolicy.BoxRetentionPolicyAction

All Implemented Interfaces:

Serializable, Comparable<BoxRetentionPolicy.BoxRetentionPolicyAction>

Enclosing class:

BoxRetentionPolicy

public static enum BoxRetentionPolicy.BoxRetentionPolicyAction
extends Enum<BoxRetentionPolicy.BoxRetentionPolicyAction>

The disposition action of the retention policy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PermanentlyDelete Will cause the content retained by the policy to be permanently deleted.
RemoveRetention Will lift the retention policy from the content, allowing it to be deleted by users.

Method Summary

Modifier and Type	Method and Description
static BoxRetentionPolicy.BoxRetentionPolicyAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoxRetentionPolicy.BoxRetentionPolicyAction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PermanentlyDelete

public static final BoxRetentionPolicy.BoxRetentionPolicyAction PermanentlyDelete

Will cause the content retained by the policy to be permanently deleted.

RemoveRetention

public static final BoxRetentionPolicy.BoxRetentionPolicyAction RemoveRetention

Will lift the retention policy from the content, allowing it to be deleted by users.

Method Detail

values

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

Returns:

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

valueOf

public static BoxRetentionPolicy.BoxRetentionPolicyAction 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