Package org.basex.server

Enum Class ServerCmd

java.lang.Object

java.lang.Enum<ServerCmd>

org.basex.server.ServerCmd

All Implemented Interfaces:

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

public enum ServerCmd
extends Enum<ServerCmd>

This class defines the available command-line commands.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

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
ADD	Code for adding a document to a database: {path}0{input}0.
BIND	Code for binding an external query variable: {id}0{name}0{val}0{type}0.
CLOSE	Code for closing the query: {id}0.
COMMAND	Code for running a database command: {path}0{input}0.
CONTEXT	Code for binding a context value: {id}0{val}0{type}0.
CREATE	Code for creating a database: {name}0{input}0.
EXEC	Code for executing the query: {id}0.
FULL	Code for executing a query and returning all information relevant for XQJ: {id}0.
INFO	Code for showing the query info: {id}0.
NEXT	Code for iterating results (obsolete).
OPTIONS	Code for showing the serializations options: {id}0.
QUERY	Code for creating a query process: {query}0.
REPLACE	Code for replacing a document in a database: {path}0{input}0.
RESULTS	Code for executing the query in an iterative manner: {id}0.
STORE	Code for storing raw data in a database: {path}0{input}0.
UPDATING	Code for returning the update flag: {id}0.

Field Summary

Fields

Modifier and Type	Field	Description
final int	code	Control code (soon obsolete).

Method Summary

Modifier and Type	Method	Description
static ServerCmd	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerCmd[]	values()	Returns an array containing the constants of this enum class, 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

QUERY

public static final ServerCmd QUERY

Code for creating a query process: {query}0.

NEXT

public static final ServerCmd NEXT

Code for iterating results (obsolete).

CLOSE

public static final ServerCmd CLOSE

Code for closing the query: {id}0.

BIND

public static final ServerCmd BIND

Code for binding an external query variable: {id}0{name}0{val}0{type}0.

RESULTS

public static final ServerCmd RESULTS

Code for executing the query in an iterative manner: {id}0.

EXEC

public static final ServerCmd EXEC

Code for executing the query: {id}0.

INFO

public static final ServerCmd INFO

Code for showing the query info: {id}0.

OPTIONS

public static final ServerCmd OPTIONS

Code for showing the serializations options: {id}0.

CREATE

public static final ServerCmd CREATE

Code for creating a database: {name}0{input}0.

ADD

public static final ServerCmd ADD

Code for adding a document to a database: {path}0{input}0.

REPLACE

public static final ServerCmd REPLACE

Code for replacing a document in a database: {path}0{input}0.

STORE

public static final ServerCmd STORE

Code for storing raw data in a database: {path}0{input}0.

CONTEXT

public static final ServerCmd CONTEXT

Code for binding a context value: {id}0{val}0{type}0.

UPDATING

public static final ServerCmd UPDATING

Code for returning the update flag: {id}0.

FULL

public static final ServerCmd FULL

Code for executing a query and returning all information relevant for XQJ: {id}0.

COMMAND

public static final ServerCmd COMMAND

Code for running a database command: {path}0{input}0.

Field Details

code

public final int code

Control code (soon obsolete).

Method Details

values

public static ServerCmd[] values()

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

Returns:

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

valueOf

public static ServerCmd valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null