com.exalead.papi.helper

Enum EnumerationMode

java.lang.Object

java.lang.Enum<EnumerationMode>

com.exalead.papi.helper.EnumerationMode

All Implemented Interfaces:

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

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

Enumeration mode used by the enumerateSyncedEntries and countSyncedEntries operations. The '/' is the separator character used to hierarchically organize the documents. The '/' also has the semantics of a 'new folder', so the paths 'a/b/doc' and 'a/b///doc' are NOT the same. For example:

• a/b/doc: Folder a > Folder b > Document doc
• a/b///doc: Folder a > Folder b > Folder > Folder > Document doc

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_RECURSIVE_ALL Enumerate non recursively the documents and folders contained in a given folder.
NOT_RECURSIVE_DOCUMENTS Enumerate non recursively the documents contained in a given folder.
NOT_RECURSIVE_FOLDERS Enumerate non recursively the folders contained in a given folder.
RECURSIVE_DOCUMENTS Recursively enumerate all the documents contained in a given folder.

Method Summary

Modifier and Type	Method and Description
static EnumerationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumerationMode[]	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

NOT_RECURSIVE_FOLDERS

public static final EnumerationMode NOT_RECURSIVE_FOLDERS

Enumerate non recursively the folders contained in a given folder.

NOT_RECURSIVE_DOCUMENTS

public static final EnumerationMode NOT_RECURSIVE_DOCUMENTS

Enumerate non recursively the documents contained in a given folder.

NOT_RECURSIVE_ALL

public static final EnumerationMode NOT_RECURSIVE_ALL

Enumerate non recursively the documents and folders contained in a given folder.

RECURSIVE_DOCUMENTS

public static final EnumerationMode RECURSIVE_DOCUMENTS

Recursively enumerate all the documents contained in a given folder.

Method Detail

values

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

Returns:

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

valueOf

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