Package io.stargate.sdk.doc.domain

Enum DocumentFunction

java.lang.Object

java.lang.Enum<DocumentFunction>

io.stargate.sdk.doc.domain.DocumentFunction

All Implemented Interfaces:

Serializable, Comparable<DocumentFunction>, java.lang.constant.Constable

public enum DocumentFunction
extends Enum<DocumentFunction>

List built-in functions in a namespace.

Author:

Cedrick LUNVEN (@clunven)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
POP	Pop an item from a list.
PUSH	Add an item to a list.

Method Summary

Modifier and Type	Method	Description
String	getOperation()	Getter for the operation.
static DocumentFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DocumentFunction[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PUSH

public static final DocumentFunction PUSH

Add an item to a list.

POP

public static final DocumentFunction POP

Pop an item from a list.

Method Details

values

public static DocumentFunction[] 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 DocumentFunction 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

getOperation

public String getOperation()

Getter for the operation.

Returns:

target operation