org.apache.manifoldcf.scriptengine

Class VariableConnectionName

java.lang.Object

org.apache.manifoldcf.scriptengine.VariableBase

org.apache.manifoldcf.scriptengine.VariableConnectionName

All Implemented Interfaces:

Variable, VariableReference

public class VariableConnectionName
extends VariableBase

Variable class representing a ManifoldCF API URL connection name segment. In conjunction with the URL variable, this variable will properly character-stuff the connection name to make a valid URL.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	connectionName
protected java.lang.String	encodedConnectionName

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
VariableConnectionName(java.lang.String connectionName)

Method Summary

Modifier and Type	Method and Description
VariableReference	doubleEquals(Variable v)
protected static java.lang.String	encode(java.lang.String connectionName)
boolean	equals(java.lang.Object o)
VariableReference	exclamationEquals(Variable v)
java.lang.String	getScriptValue() Get the variable's script value
java.lang.String	getStringValue() Get the variable's value as a string
java.lang.String	getURLPathValue() Get the variable's value as a URL path component
int	hashCode()
boolean	hasScriptValue() Check if the variable has a script value
boolean	hasStringValue() Check if the variable has a string value
boolean	hasURLPathValue() Check if the variable has a URL path value

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

ampersand, asterisk, composeMessage, doubleAmpersand, doublePipe, getAttribute, getBooleanValue, getConfigurationNodeValue, getConfigurationValue, getDoubleValue, getIndexed, getIntValue, getQueryArgumentValue, greaterAngle, greaterAngleEquals, hasBooleanValue, hasConfigurationNodeValue, hasConfigurationValue, hasDoubleValue, hasIntValue, hasQueryArgumentValue, 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

encodedConnectionName

protected java.lang.String encodedConnectionName

connectionName

protected java.lang.String connectionName

Constructor Detail

VariableConnectionName

public VariableConnectionName(java.lang.String connectionName)

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

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

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

hasURLPathValue

public boolean hasURLPathValue()
                        throws ScriptException

Check if the variable has a URL path value

Specified by:

hasURLPathValue in interface Variable

Overrides:

hasURLPathValue in class VariableBase

Throws:

ScriptException

getURLPathValue

public java.lang.String getURLPathValue()
                                 throws ScriptException

Get the variable's value as a URL path component

Specified by:

getURLPathValue in interface Variable

Overrides:

getURLPathValue in class VariableBase

Throws:

ScriptException

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

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

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

encode

protected static java.lang.String encode(java.lang.String connectionName)