Package org.basex.core.cmd

Class Get

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.Get

public final class Get
extends Command

Evaluates the 'get' command and return the value of a database option.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.core.Command

args, context, exception, in, maxResults, openDB, options, out, soptions, uri

Fields inherited from class org.basex.core.jobs.Job

state, updating

Constructor Summary

Constructors

Constructor	Description
Get()	Empty constructor.
Get(String key)	Default constructor.
Get(Option<?> option)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addLocks()	Adds the strings (databases, special identifiers) for which locks need to be acquired.
static Object	get(String name, Context ctx)	Returns the value of the specified option.
protected boolean	run()	Executes the command and serializes the result (internal call).

Methods inherited from class org.basex.core.Command

addLocks, baseURI, baseURI, build, close, error, exception, execute, execute, getOption, getOption, info, info, init, maxResults, newData, result, run, run, setInput, setInput, stoppable, supportsProg, toString, toString, updated, updating

Methods inherited from class org.basex.core.jobs.Job

active, checkStop, detailedInfo, jc, memory, popJob, progressInfo, pushJob, register, shortInfo, state, stop, stopped, timeout, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Get

public Get()

Empty constructor.

Get

public Get(Option<?> option)

Default constructor.

Parameters:

option - option to be found

Get

public Get(String key)

Default constructor.

Parameters:

key - key to be found (can be null)

Method Details

run

protected boolean run()
               throws 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:

IOException - I/O exception

get

public static Object get(String name,
 Context ctx)

Returns the value of the specified option.

Parameters:

name - name of option

ctx - database context

Returns:

value

addLocks

public void addLocks()

Description copied from class: Job

Adds the strings (databases, special identifiers) for which locks need to be acquired.

Overrides:

addLocks in class Job