org.apache.manifoldcf.scriptengine

Class VariableQueryArg

java.lang.Object

org.apache.manifoldcf.scriptengine.VariableBase

org.apache.manifoldcf.scriptengine.VariableQueryArg

All Implemented Interfaces:

Variable, VariableReference

public class VariableQueryArg
extends VariableBase

Variable class representing a ManifoldCF query argument, with a name and a value.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected java.lang.String	value

Fields inherited from interface org.apache.manifoldcf.scriptengine.Variable

ATTRIBUTE_BOOLEAN, ATTRIBUTE_CREATEDSTATUS, ATTRIBUTE_DICT, ATTRIBUTE_FLOAT, ATTRIBUTE_INT, ATTRIBUTE_NOTFOUNDSTATUS, ATTRIBUTE_OKSTATUS, ATTRIBUTE_SCRIPT, ATTRIBUTE_SIZE, ATTRIBUTE_STRING, ATTRIBUTE_TYPE, ATTRIBUTE_UNAUTHORIZEDSTATUS, ATTRIBUTE_VALUE

Constructor Summary

Constructors

Constructor and Description
VariableQueryArg(java.lang.String name, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
VariableReference	doubleEquals(Variable v)
boolean	equals(java.lang.Object o)
protected static java.lang.String	escapeValue(java.lang.String input)
VariableReference	exclamationEquals(Variable v)
java.lang.String	getQueryArgumentValue() Get the variable's value as a properly-encoded query argument
java.lang.String	getScriptValue() Get the variable's script value
java.lang.String	getStringValue() Get the variable's value as a string
int	hashCode()
boolean	hasQueryArgumentValue() Check if the variable has a query arg value
boolean	hasScriptValue() Check if the variable has a script value
boolean	hasStringValue() Check if the variable has a string value

Methods inherited from class org.apache.manifoldcf.scriptengine.VariableBase

ampersand, asterisk, composeMessage, doubleAmpersand, doublePipe, getAttribute, getBooleanValue, getConfigurationNodeValue, getConfigurationValue, getDoubleValue, getIndexed, getIntValue, getURLPathValue, greaterAngle, greaterAngleEquals, hasBooleanValue, hasConfigurationNodeValue, hasConfigurationValue, hasDoubleValue, hasIntValue, hasURLPathValue, insertAt, isNull, lesserAngle, lesserAngleEquals, minus, pipe, plus, removeAt, resolve, setReference, slash, unaryExclamation, unaryMinus

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected final java.lang.String name

value

protected final java.lang.String value

Constructor Detail

VariableQueryArg

public VariableQueryArg(java.lang.String name,
                        java.lang.String value)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hasStringValue

public boolean hasStringValue()
                       throws ScriptException

Check if the variable has a string value

Specified by:

hasStringValue in interface Variable

Overrides:

hasStringValue in class VariableBase

Throws:

ScriptException

hasScriptValue

public boolean hasScriptValue()
                       throws ScriptException

Check if the variable has a script value

Specified by:

hasScriptValue in interface Variable

Overrides:

hasScriptValue in class VariableBase

Throws:

ScriptException

hasQueryArgumentValue

public boolean hasQueryArgumentValue()
                              throws ScriptException

Check if the variable has a query arg value

Specified by:

hasQueryArgumentValue in interface Variable

Overrides:

hasQueryArgumentValue in class VariableBase

Throws:

ScriptException

getScriptValue

public java.lang.String getScriptValue()
                                throws ScriptException

Get the variable's script value

Specified by:

getScriptValue in interface Variable

Overrides:

getScriptValue in class VariableBase

Throws:

ScriptException

escapeValue

protected static java.lang.String escapeValue(java.lang.String input)

getStringValue

public java.lang.String getStringValue()
                                throws ScriptException

Get the variable's value as a string

Specified by:

getStringValue in interface Variable

Overrides:

getStringValue in class VariableBase

Throws:

ScriptException

getQueryArgumentValue

public java.lang.String getQueryArgumentValue()
                                       throws ScriptException

Description copied from class: VariableBase

Get the variable's value as a properly-encoded query argument

Specified by:

getQueryArgumentValue in interface Variable

Overrides:

getQueryArgumentValue in class VariableBase

Throws:

ScriptException

doubleEquals

public VariableReference doubleEquals(Variable v)
                               throws ScriptException

Specified by:

doubleEquals in interface Variable

Overrides:

doubleEquals in class VariableBase

Throws:

ScriptException

exclamationEquals

public VariableReference exclamationEquals(Variable v)
                                    throws ScriptException

Specified by:

exclamationEquals in interface Variable

Overrides:

exclamationEquals in class VariableBase

Throws:

ScriptException