org.basex.core.cmd

Class Help

java.lang.Object

org.basex.core.Progress

org.basex.core.Command

org.basex.core.cmd.Help

public final class Help
extends Command

Evaluates the 'help' command and returns help on the database commands.

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
Help(java.lang.String arg) Default constructor.
Help(java.lang.String arg, java.lang.String format) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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

Help

public Help(java.lang.String arg)

Default constructor.

Parameters:

arg - optional argument

Help

public Help(java.lang.String arg,
    java.lang.String format)

Default constructor.

Parameters:

arg - optional argument

format - optional format (e.g., Wiki)

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