com.exalead.papi.helper.io

Enum PAPI_COMMAND

java.lang.Object

java.lang.Enum<PAPI_COMMAND>

com.exalead.papi.helper.io.PAPI_COMMAND

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_DOCUMENT
ADD_DOCUMENT_LIST
ARE_DOCUMENTS_SEARCHABLE
ARE_DOCUMENTS_SEARCHABLE_2xBOOL
CLEAR_ALL_CHECKPOINTS
CLEAR_CHECKPOINTS
COUNT_SYNCED_ENTRIES
DELETE_DOCUMENT
DELETE_DOCUMENT_LIST_DIDS
DELETE_DOCUMENT_LIST_URIS
DELETE_DOCUMENTS_PREFIX
DELETE_DOCUMENTS_ROOT_PATH
ENUMERATE_CHECKPOINTS_INFO
ENUMERATE_SYNCED_ENTRIES
GET_CHECKPOINT
GET_CHECKPOINT_INFO
GET_DOCUMENT_DIDS_AND_SLICES
GET_DOCUMENTS_STATUS
GET_DOCUMENTS_STATUS_LIST
PING
SET_CHECKPOINT
START_SESSION
STOP_SESSION
SUGGEST_SYNCED_ENTRIES
SYNC
SYNCHRONIZE
TRIGGER_INDEXING_JOB
UPDATE_DOCUMENT
UPDATE_DOCUMENT_LIST
UPDATE_DOCUMENT_METAS
UPDATE_DOCUMENT_METAS_LIST

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<PAPI_COMMAND>	allCommands()
static PAPI_COMMAND	fromCommandName(java.lang.String commandName)
int	size()
java.lang.String	toString()
static PAPI_COMMAND	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PAPI_COMMAND[]	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

ADD_DOCUMENT

public static final PAPI_COMMAND ADD_DOCUMENT

ADD_DOCUMENT_LIST

public static final PAPI_COMMAND ADD_DOCUMENT_LIST

UPDATE_DOCUMENT

public static final PAPI_COMMAND UPDATE_DOCUMENT

UPDATE_DOCUMENT_METAS

public static final PAPI_COMMAND UPDATE_DOCUMENT_METAS

UPDATE_DOCUMENT_LIST

public static final PAPI_COMMAND UPDATE_DOCUMENT_LIST

UPDATE_DOCUMENT_METAS_LIST

public static final PAPI_COMMAND UPDATE_DOCUMENT_METAS_LIST

PING

public static final PAPI_COMMAND PING

DELETE_DOCUMENT

public static final PAPI_COMMAND DELETE_DOCUMENT

DELETE_DOCUMENT_LIST_URIS

public static final PAPI_COMMAND DELETE_DOCUMENT_LIST_URIS

DELETE_DOCUMENT_LIST_DIDS

public static final PAPI_COMMAND DELETE_DOCUMENT_LIST_DIDS

DELETE_DOCUMENTS_ROOT_PATH

public static final PAPI_COMMAND DELETE_DOCUMENTS_ROOT_PATH

DELETE_DOCUMENTS_PREFIX

public static final PAPI_COMMAND DELETE_DOCUMENTS_PREFIX

GET_DOCUMENTS_STATUS

public static final PAPI_COMMAND GET_DOCUMENTS_STATUS

GET_DOCUMENTS_STATUS_LIST

public static final PAPI_COMMAND GET_DOCUMENTS_STATUS_LIST

SET_CHECKPOINT

public static final PAPI_COMMAND SET_CHECKPOINT

GET_CHECKPOINT

public static final PAPI_COMMAND GET_CHECKPOINT

GET_CHECKPOINT_INFO

public static final PAPI_COMMAND GET_CHECKPOINT_INFO

CLEAR_CHECKPOINTS

public static final PAPI_COMMAND CLEAR_CHECKPOINTS

CLEAR_ALL_CHECKPOINTS

public static final PAPI_COMMAND CLEAR_ALL_CHECKPOINTS

ENUMERATE_CHECKPOINTS_INFO

public static final PAPI_COMMAND ENUMERATE_CHECKPOINTS_INFO

SYNC

public static final PAPI_COMMAND SYNC

SYNCHRONIZE

public static final PAPI_COMMAND SYNCHRONIZE

TRIGGER_INDEXING_JOB

public static final PAPI_COMMAND TRIGGER_INDEXING_JOB

ARE_DOCUMENTS_SEARCHABLE

public static final PAPI_COMMAND ARE_DOCUMENTS_SEARCHABLE

ARE_DOCUMENTS_SEARCHABLE_2xBOOL

public static final PAPI_COMMAND ARE_DOCUMENTS_SEARCHABLE_2xBOOL

ENUMERATE_SYNCED_ENTRIES

public static final PAPI_COMMAND ENUMERATE_SYNCED_ENTRIES

COUNT_SYNCED_ENTRIES

public static final PAPI_COMMAND COUNT_SYNCED_ENTRIES

SUGGEST_SYNCED_ENTRIES

public static final PAPI_COMMAND SUGGEST_SYNCED_ENTRIES

GET_DOCUMENT_DIDS_AND_SLICES

public static final PAPI_COMMAND GET_DOCUMENT_DIDS_AND_SLICES

START_SESSION

public static final PAPI_COMMAND START_SESSION

STOP_SESSION

public static final PAPI_COMMAND STOP_SESSION

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<PAPI_COMMAND>

size

public int size()

Returns:

The length in bytes when #writeTo(OutputStream) is invoked.

allCommands

public static java.util.Collection<PAPI_COMMAND> allCommands()

fromCommandName

public static PAPI_COMMAND fromCommandName(java.lang.String commandName)