org.basex.core.cmd
Class List

java.lang.Object
  extended by org.basex.core.Proc
      extended by org.basex.core.Command
          extended by org.basex.core.cmd.List

public final class List
extends Command

Evaluates the 'list' command and shows all available databases.

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

Field Summary
 
Fields inherited from class org.basex.core.Command
args, context, in, mprop, out, perf, prop
 
Fields inherited from class org.basex.core.Proc
listen, updating
 
Constructor Summary
List()
          Default constructor.
List(java.lang.String name)
          Default constructor.
List(java.lang.String name, java.lang.String path)
          Default constructor.
 
Method Summary
 void databases(LockResult lr)
          Adds the names of the databases that may be touched by the process.
static StringList list(Context ctx)
          Returns a list of all databases.
protected  boolean run()
          Executes the command and serializes the result (internal call).
 
Methods inherited from class org.basex.core.Command
build, close, databases, error, execute, execute, getOption, getOption, info, info, newData, result, run, run, setInput, setInput, stoppable, supportsProg, toString, updated, updating
 
Methods inherited from class org.basex.core.Proc
abort, checkStop, det, detail, listen, proc, prog, progress, registered, registered, startTimeout, stop, stopTimeout, tit, title
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

List

public List()
Default constructor.


List

public List(java.lang.String name)
Default constructor.

Parameters:
name - database name

List

public List(java.lang.String name,
            java.lang.String path)
Default constructor.

Parameters:
name - database name
path - database path
Method Detail

run

protected boolean run()
               throws java.io.IOException
Description copied from class: Command
Executes the command and serializes the result (internal call).

Specified by:
run in class Command
Returns:
success of operation
Throws:
java.io.IOException - I/O exception

databases

public void databases(LockResult lr)
Description copied from class: Proc
Adds the names of the databases that may be touched by the process.

Overrides:
databases in class Proc
Parameters:
lr - Container for lock result to pass around

list

public static StringList list(Context ctx)
Returns a list of all databases.

Parameters:
ctx - database context
Returns:
list of databases