org.basex.core

Class CommandBuilder

java.lang.Object

org.basex.core.CommandBuilder

public final class CommandBuilder
extends java.lang.Object

This class simplifies the composition of the string representation of a database command.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor and Description
CommandBuilder(Command c) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
CommandBuilder	arg(int arg) Adds the specified argument.
CommandBuilder	arg(java.lang.String key, int arg) Adds an argument with an optional prefix.
CommandBuilder	args() Returns a string representation of all arguments.
CommandBuilder	init() Initializes the builder with the class name of the command in upper case.
CommandBuilder	init(java.lang.String s) Initializes the builder with the specified string.
java.lang.String	toString()
CommandBuilder	xquery(int arg) Adds the specified argument as XQuery string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandBuilder

public CommandBuilder(Command c)

Constructor.

Parameters:

c - command

Method Detail

init

public CommandBuilder init()

Initializes the builder with the class name of the command in upper case.

Returns:

self instance

init

public CommandBuilder init(java.lang.String s)

Initializes the builder with the specified string.

Parameters:

s - command string

Returns:

self instance

args

public CommandBuilder args()

Returns a string representation of all arguments.

Returns:

self instance

xquery

public CommandBuilder xquery(int arg)

Adds the specified argument as XQuery string.

Parameters:

arg - argument index

Returns:

self instance

arg

public CommandBuilder arg(int arg)

Adds the specified argument.

Parameters:

arg - argument index

Returns:

self instance

arg

public CommandBuilder arg(java.lang.String key,
                 int arg)

Adds an argument with an optional prefix.

Parameters:

key - optional keyword prefix

arg - argument index

Returns:

self instance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object