Package org.basex.core.cmd

Class JobsList

java.lang.Object

org.basex.core.jobs.Job

org.basex.core.Command

org.basex.core.cmd.JobsList

public final class JobsList
extends Command

Evaluates the 'jobs list' command.

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
JobsList()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addLocks()	Adds the strings (databases, special identifiers) for which locks need to be acquired.
void	build(CmdBuilder cb)	Builds a string representation from the command.
static TokenList	entry(byte[] key, JobPool jobs, int max)	Creates a table entry.
static TokenList	ids(Context ctx)	Returns all registered ids.
protected boolean	run()	Executes the command and serializes the result (internal call).

Methods inherited from class org.basex.core.Command

addLocks, baseURI, baseURI, 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

JobsList

public JobsList()

Default constructor.

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

ids

public static TokenList ids(Context ctx)

Returns all registered ids.

Parameters:

ctx - database context

Returns:

id list

entry

public static TokenList entry(byte[] key,
 JobPool jobs,
 int max)

Creates a table entry.

Parameters:

key - job id

jobs - job pool

max - maximum length of text entry

Returns:

table entry, or null if the job does not exist

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

build

public void build(CmdBuilder cb)

Description copied from class: Command

Builds a string representation from the command. This string must be correctly built, as commands are sent to the server as strings.

Overrides:

build in class Command

Parameters:

cb - command builder