org.alfresco.module.vti.metadata.dic

Enum GetOption

java.lang.Object

java.lang.Enum<GetOption>

org.alfresco.module.vti.metadata.dic.GetOption

All Implemented Interfaces:

Serializable, Comparable<GetOption>

public enum GetOption
extends Enum<GetOption>

Used to define the behavior of retrieving documents operations.

Author:

Michael Shavnev

Enum Constant Summary

Enum Constants

Enum Constant and Description
chkoutExclusive Check out the file exclusively
chkoutNonExclusive Check out the file non-exclusively
none Do not check out the file

Method Summary

Modifier and Type	Method and Description
static EnumSet<GetOption>	getOptions(String stringValues)
static GetOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static GetOption[]	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 GetOption none

Do not check out the file

chkoutExclusive

public static final GetOption chkoutExclusive

Check out the file exclusively

chkoutNonExclusive

public static final GetOption chkoutNonExclusive

Check out the file non-exclusively

Method Detail

values

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

Returns:

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

valueOf

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

getOptions

public static EnumSet<GetOption> getOptions(String stringValues)