Module io.ebean.api

Package io.ebean

Enum DocStoreQueueEntry.Action

java.lang.Object

java.lang.Enum<DocStoreQueueEntry.Action>

io.ebean.DocStoreQueueEntry.Action

All Implemented Interfaces:

Serializable, Comparable<DocStoreQueueEntry.Action>

Enclosing class:

DocStoreQueueEntry

public static enum DocStoreQueueEntry.Action
extends Enum<DocStoreQueueEntry.Action>

Action to either update or delete a document from the index.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETE	Action is to delete a document from the doc store..
INDEX	Action is to update a document in the doc store.
NESTED	An update is required based on a change to a nested/embedded object at a given path.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value associated with this action type.
static DocStoreQueueEntry.Action	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DocStoreQueueEntry.Action[]	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 Details

INDEX

public static final DocStoreQueueEntry.Action INDEX

Action is to update a document in the doc store.

DELETE

public static final DocStoreQueueEntry.Action DELETE

Action is to delete a document from the doc store..

NESTED

public static final DocStoreQueueEntry.Action NESTED

An update is required based on a change to a nested/embedded object at a given path.

Method Details

values

public static DocStoreQueueEntry.Action[] values()

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

Returns:

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

valueOf

public static DocStoreQueueEntry.Action 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

getValue

public int getValue()

Return the value associated with this action type.