org.basex.core
Enum Commands.Cmd

java.lang.Object
  extended by java.lang.Enum<Commands.Cmd>
      extended by org.basex.core.Commands.Cmd
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Commands.Cmd>
Enclosing interface:
Commands

public static enum Commands.Cmd
extends java.lang.Enum<Commands.Cmd>

Command definitions.


Enum Constant Summary
BASH
           
CHECK
           
CLOSE
           
COPY
           
CREATE
           
CS
           
DELETE
           
DROP
           
DUMMYDATABASE
           
DUMMYGENERAL
           
DUMMYQUERY
           
DUMMYUPDATE
           
EXIT
           
EXPORT
           
FIND
           
GETINFO
           
GETRESULT
           
HELP
           
INFO
           
INSERT
           
LIST
           
OPEN
           
OPTIMIZE
           
PING
           
PROMPT
           
QUIT
           
SET
           
STOP
           
UPDATE
           
XMARK
           
XPATH
           
XPATHMV
           
XQUENV
           
XQUERY
           
 
Method Summary
 java.lang.String help(boolean detail, boolean all)
          Returns a help string.
static Commands.Cmd valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Commands.Cmd[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DUMMYDATABASE

public static final Commands.Cmd DUMMYDATABASE

CREATE

public static final Commands.Cmd CREATE

OPEN

public static final Commands.Cmd OPEN

INFO

public static final Commands.Cmd INFO

CHECK

public static final Commands.Cmd CHECK

CLOSE

public static final Commands.Cmd CLOSE

LIST

public static final Commands.Cmd LIST

DROP

public static final Commands.Cmd DROP

OPTIMIZE

public static final Commands.Cmd OPTIMIZE

EXPORT

public static final Commands.Cmd EXPORT

DUMMYQUERY

public static final Commands.Cmd DUMMYQUERY

XPATH

public static final Commands.Cmd XPATH

XPATHMV

public static final Commands.Cmd XPATHMV

XQUERY

public static final Commands.Cmd XQUERY

XQUENV

public static final Commands.Cmd XQUENV

FIND

public static final Commands.Cmd FIND

XMARK

public static final Commands.Cmd XMARK

CS

public static final Commands.Cmd CS

BASH

public static final Commands.Cmd BASH

DUMMYUPDATE

public static final Commands.Cmd DUMMYUPDATE

COPY

public static final Commands.Cmd COPY

DELETE

public static final Commands.Cmd DELETE

INSERT

public static final Commands.Cmd INSERT

UPDATE

public static final Commands.Cmd UPDATE

DUMMYGENERAL

public static final Commands.Cmd DUMMYGENERAL

SET

public static final Commands.Cmd SET

HELP

public static final Commands.Cmd HELP

PING

public static final Commands.Cmd PING

PROMPT

public static final Commands.Cmd PROMPT

EXIT

public static final Commands.Cmd EXIT

QUIT

public static final Commands.Cmd QUIT

GETRESULT

public static final Commands.Cmd GETRESULT

GETINFO

public static final Commands.Cmd GETINFO

STOP

public static final Commands.Cmd STOP
Method Detail

values

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

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

valueOf

public static Commands.Cmd 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

help

public final java.lang.String help(boolean detail,
                                   boolean all)
Returns a help string.

Parameters:
detail - show details
all - show all commands (also hidden ones)
Returns:
string