org.basex.server
Enum ServerCmd

java.lang.Object
  extended by java.lang.Enum<ServerCmd>
      extended by org.basex.server.ServerCmd
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ServerCmd>

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

This class defines the available command-line commands.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Enum Constant Summary
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 item: {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.
UNWATCH
          Code for unwatching an event: {name}0.
UPDATING
          Code for returning the update flag: {id}0.
WATCH
          Code for watching an event: {name}0.
 
Field Summary
 int code
          Control code (soon obsolete).
 
Method Summary
static ServerCmd valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ServerCmd[] 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

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.


WATCH

public static final ServerCmd WATCH
Code for watching an event: {name}0.


UNWATCH

public static final ServerCmd UNWATCH
Code for unwatching an event: {name}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 item: {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 Detail

code

public final int code
Control code (soon obsolete).

Method Detail

values

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

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

valueOf

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