org.basex.core.cmd

Class List

java.lang.Object

org.basex.core.Progress

org.basex.core.Command

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, DATAREF, in, mprop, out, perf, prop, STANDARD

Fields inherited from class org.basex.core.Progress

updating

Constructor Summary

Constructors

Constructor and Description
List() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static StringList	list(Context ctx) Returns a list of all databases.
static StringList	list(Context ctx, boolean backups) Returns a list of all databases and (optionally) backed up databases.
protected boolean	run() Executes the command and serializes the result (internal call).

Methods inherited from class org.basex.core.Command

build, close, error, execute, execute, getOption, getOption, info, info, newData, pinned, result, run, setInput, setInput, stoppable, supportsProg, toString, updated, updating

Methods inherited from class org.basex.core.Progress

abort, checkStop, det, detail, prog, progress, progress, 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.

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

list

public static StringList list(Context ctx)

Returns a list of all databases.

Parameters:

ctx - database context

Returns:

list of databases

list

public static StringList list(Context ctx,
              boolean backups)

Returns a list of all databases and (optionally) backed up databases.

Parameters:

ctx - database context

backups - include backups in the list

Returns:

list of databases