com.caucho.quercus.env

Class ObjectValue

java.lang.Object

com.caucho.quercus.env.Value

com.caucho.quercus.env.Callback

com.caucho.quercus.env.ObjectValue

All Implemented Interfaces:

Callable, java.io.Serializable

Direct Known Subclasses:

JavaValue, ObjectExtValue

public abstract class ObjectValue
extends Callback

Represents a Quercus object value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_className
protected java.lang.String	_incompleteObjectName
protected QuercusClass	_quercusClass

Fields inherited from class com.caucho.quercus.env.Value

L, NULL_ARGS, NULL_VALUE_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectValue(Env env)
protected	ObjectValue(Env env, QuercusClass quercusClass)

Method Summary

Modifier and Type	Method and Description
Value	append(Value index, Value value) Sets the array value, returning the new array, e.g.
StringValue	appendTo(BinaryBuilderValue sb) Append to a binary builder.
StringValue	appendTo(LargeStringBuilderValue sb) Append to a binary builder.
StringValue	appendTo(StringBuilderValue sb) Append to a binary builder.
StringValue	appendTo(UnicodeBuilderValue sb) Append to a string builder.
Value	call(Env env, Value[] args) Call for callable.
void	cleanup(Env env)
int	cmpObject(ObjectValue rValue) Compare two objects
abstract java.util.Set<? extends java.util.Map.Entry<Value,Value>>	entrySet() Returns a Set of entries.
boolean	eq(Value rValue) Returns true for equality
AbstractFunction	findFunction(StringValue methodName) Finds the method name.
QuercusClass	findQuercusClass(Env env) Returns the Quercus class for this obj/name.
Value	get(Value key) Returns the array value with the given key.
Arg[]	getArgs(Env env) Returns the formal arguments.
java.lang.String	getCallbackName() Returns the name of the callback.
java.lang.String	getClassName() Returns the value's class name.
int	getCount(Env env) Returns the count value with the given key.
java.lang.String	getDeclComment(Env env) Returns the comment in the file where this is defined in.
int	getDeclEndLine(Env env) Returns the end line in the file where this is defined in.
java.lang.String	getDeclFileName(Env env) Returns the name of the file where this is defined in.
int	getDeclStartLine(Env env) Returns the start line in the file where this is defined in.
java.lang.String	getIncompleteObjectName() Returns the name of the uninitialized object.
java.util.Iterator<java.util.Map.Entry<Value,Value>>	getIterator(Env env) Returns an iterator for the key => value pairs.
java.util.Iterator<Value>	getKeyIterator(Env env) Returns an iterator for the keys.
AbstractFunction	getMethod(StringValue name)
java.lang.String	getName() Returns the class name.
StringValue	getObjectHash(Env env) Returns the unique object hash.
java.lang.String	getParentClassName() Returns the parent class
QuercusClass	getQuercusClass() Returns the backing QuercusClass.
Value	getStaticFieldValue(Env env, StringValue name) Returns the static field.
Var	getStaticFieldVar(Env env, StringValue name) Returns the static field reference.
java.lang.String	getType() Returns the type.
java.util.Iterator<Value>	getValueIterator(Env env) Returns an iterator for the values.
void	initField(Env env, StringValue name, StringValue canonicalName, Value value) Initializes a new field, does not call __set if it is defined.
void	initIncompleteField(Env env, StringValue name, Value value, FieldVisibility visibility)
void	initObject(Env env, QuercusClass cls) Initializes the incomplete class.
boolean	isA(Env env, java.lang.String name) Returns true for an implementation of a class
boolean	isCallable(Env env, boolean isCheckSyntaxOnly, Value nameRef) The object is callable if it has an __invoke method
boolean	isEmpty(Env env, Value key) Return true if empty.
boolean	isIncompleteObject()
boolean	isInternal(Env env) Returns true if this callback is implemented internally (i.e.
boolean	isObject() Returns true for an object.
boolean	isReturnsReference(Env env) Returns true if this returns a reference.
boolean	isset(Value key) Return true if set
boolean	isValid(Env env) Checks for a valid callback.
void	jsonEncode(Env env, JsonEncodeContext context, StringValue sb) Encodes the value in JSON.
Value	put(Value value) Appends a new array value
Value	put(Value key, Value value) Sets the array value with the given key.
Value	putField(Env env, java.lang.String key, long value) Adds a new value.
Value	putField(Env env, java.lang.String key, java.lang.String value) Adds a new value.
Value	putField(Env env, java.lang.String key, Value value) Adds a new value.
Value	putField(java.lang.String key, double value) Adds a new value.
Value	putField(java.lang.String key, long value) Adds a new value.
Value	putField(java.lang.String key, java.lang.String value) Adds a new value.
Value	remove(Value key) Unsets the array value
void	setClassName(java.lang.String className)
void	setIncompleteObjectName(java.lang.String name) Sets the name of uninitialized object.
void	setQuercusClass(QuercusClass cl)
Value	setStaticFieldRef(Env env, StringValue name, Value value) Sets the static field.
Value	toAutoArray() Converts to an array if null.
boolean	toBoolean() Converts to a boolean.
Callable	toCallable(Env env, boolean isOptional) Converts to a callable
double	toDouble() Converts to a double.
java.lang.Enum	toJavaEnum(Env env, java.lang.Class cls) Converts to a Java Enum.
long	toLong() Converts to a long.
void	varDumpObject(Env env, WriteStream out, int depth, java.util.IdentityHashMap<Value,java.lang.String> valueSet)

Methods inherited from class com.caucho.quercus.env.Callback

callArray, callArray, callArray, toString

Methods inherited from class com.caucho.quercus.env.Value

abs, add, add, addOne, bitAnd, bitOr, bitXor, call, call, call, call, call, call, callCopy, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callRef, callRef, callRef, callRef, callRef, callRef, callRef, charValueAt, checkPrivate, checkProtected, clone, cmp, containsKey, copy, copy, copy, copyArrayItem, copyReturn, copySaveFunArg, copyStringBuilder, copyTree, current, div, div, end, eql, eqValue, generate, geq, get, getArg, getArgTail, getArray, getArray, getBaseIterator, getCallableName, getCalledClass, getCountRecursive, getDirty, getField, getFieldArg, getFieldArgRef, getFieldArray, getFieldObject, getFieldVar, getHashCode, getKeyArray, getObject, getObject, getRef, getResourceType, getSize, getThisField, getThisFieldArg, getThisFieldArgRef, getThisFieldArray, getThisFieldObject, getThisFieldVar, getValueArray, getValueType, getVar, gt, hasCurrent, hashCode, increment, initField, initField, isA, isArray, isBinary, isBoolean, isDefault, isDouble, isDoubleConvertible, isEmpty, isFieldExists, isFieldInit, isLong, isLongConvertible, isNull, isNumberConvertible, isNumeric, isResource, isset, issetField, issetThisField, isString, isUnicode, isVar, key, keyExists, length, leq, lshift, lt, mod, mul, mul, neg, next, nextIndex, pop, pos, postdecr, postincr, postincr, predecr, preincr, preincr, prev, print, print, printDepth, printJavaChar, printJavaString, printR, printRImpl, put, putArray, putField, putField, putObject, putThisField, putThisField, putThisFieldArray, putVar, reset, rshift, serialize, serialize, set, setCharValueAt, setFieldInit, setJavaObject, shuffle, sub_rev, sub, sub, subOne, toArgRef, toArray, toArrayValue, toAutoObject, toBigDecimal, toBigInteger, toBinaryValue, toBinaryValue, toBinaryValue, toBinaryValueMarshalCost, toBooleanMarshalCost, toByteArrayMarshalCost, toByteMarshalCost, toChar, toCharArrayMarshalCost, toCharMarshalCost, toDebugString, toDouble, toDouble, toDouble, toDouble, toDoubleMarshalCost, toDoubleValue, toException, toFloatMarshalCost, toInputStream, toInt, toIntegerMarshalCost, toInternString, toJavaBoolean, toJavaByte, toJavaCalendar, toJavaCharacter, toJavaCollection, toJavaDate, toJavaDouble, toJavaFloat, toJavaInteger, toJavaList, toJavaLong, toJavaMap, toJavaObject, toJavaObject, toJavaObjectMarshalCost, toJavaObjectNotNull, toJavaShort, toJavaString, toJavaURL, toKey, toLocalRef, toLocalThis, toLocalValue, toLocalValueReadOnly, toLocalVar, toLocalVarDeclAsRef, toLong, toLong, toLong, toLong, toLongMarshalCost, toLongValue, toObject, toRef, toRefValue, toShortMarshalCost, toString, toStringBuilder, toStringBuilder, toStringBuilder, toStringBuilder, toStringMarshalCost, toStringValue, toStringValue, toStringValueMarshalCost, toUnicode, toUnicodeValue, toUnicodeValue, toUnicodeValueMarshalCost, toValue, toVar, unsetArray, unsetField, unsetThisArray, unsetThisField, unsetThisPrivateField, valuesToArray, varDump, varDumpImpl, varExport, varExportImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.caucho.quercus.env.Callable

call, call, call, call, call, call

Field Detail

_quercusClass

protected transient QuercusClass _quercusClass

_className

protected java.lang.String _className

_incompleteObjectName

protected java.lang.String _incompleteObjectName

Constructor Detail

ObjectValue

protected ObjectValue(Env env)

ObjectValue

protected ObjectValue(Env env,
                      QuercusClass quercusClass)

Method Detail

setQuercusClass

public void setQuercusClass(QuercusClass cl)

getQuercusClass

public QuercusClass getQuercusClass()

Description copied from class: Value

Returns the backing QuercusClass.

Overrides:

getQuercusClass in class Value

findQuercusClass

public QuercusClass findQuercusClass(Env env)

Description copied from class: Value

Returns the Quercus class for this obj/name.

Overrides:

findQuercusClass in class Value

getMethod

public AbstractFunction getMethod(StringValue name)

isIncompleteObject

public boolean isIncompleteObject()

getIncompleteObjectName

public java.lang.String getIncompleteObjectName()

Returns the name of the uninitialized object.

setIncompleteObjectName

public void setIncompleteObjectName(java.lang.String name)

Sets the name of uninitialized object.

initObject

public void initObject(Env env,
                       QuercusClass cls)

Initializes the incomplete class.

cleanup

public final void cleanup(Env env)

getClassName

public java.lang.String getClassName()

Returns the value's class name.

Overrides:

getClassName in class Value

setClassName

public void setClassName(java.lang.String className)

entrySet

public abstract java.util.Set<? extends java.util.Map.Entry<Value,Value>> entrySet()

Returns a Set of entries.

getName

public java.lang.String getName()

Returns the class name.

getParentClassName

public java.lang.String getParentClassName()

Returns the parent class

isObject

public boolean isObject()

Returns true for an object.

Overrides:

isObject in class Value

getType

public java.lang.String getType()

Returns the type.

Overrides:

getType in class Value

getObjectHash

public StringValue getObjectHash(Env env)

Returns the unique object hash.

Overrides:

getObjectHash in class Value

isCallable

public boolean isCallable(Env env,
                          boolean isCheckSyntaxOnly,
                          Value nameRef)

The object is callable if it has an __invoke method

Overrides:

isCallable in class Value

toCallable

public Callable toCallable(Env env,
                           boolean isOptional)

Description copied from class: Value

Converts to a callable

Overrides:

toCallable in class Callback

isValid

public boolean isValid(Env env)

Description copied from interface: Callable

Checks for a valid callback.

Specified by:

isValid in interface Callable

Specified by:

isValid in class Callback

Returns:

true if this is an invalid callback reference

getCallbackName

public java.lang.String getCallbackName()

Description copied from class: Callback

Returns the name of the callback.

Specified by:

getCallbackName in interface Callable

Specified by:

getCallbackName in class Callback

getDeclFileName

public java.lang.String getDeclFileName(Env env)

Description copied from interface: Callable

Returns the name of the file where this is defined in.

getDeclStartLine

public int getDeclStartLine(Env env)

Description copied from interface: Callable

Returns the start line in the file where this is defined in.

getDeclEndLine

public int getDeclEndLine(Env env)

Description copied from interface: Callable

Returns the end line in the file where this is defined in.

getDeclComment

public java.lang.String getDeclComment(Env env)

Description copied from interface: Callable

Returns the comment in the file where this is defined in.

isReturnsReference

public boolean isReturnsReference(Env env)

Description copied from interface: Callable

Returns true if this returns a reference.

getArgs

public Arg[] getArgs(Env env)

Description copied from interface: Callable

Returns the formal arguments.

isInternal

public boolean isInternal(Env env)

Description copied from class: Callback

Returns true if this callback is implemented internally (i.e. in Java).

Specified by:

isInternal in class Callback

toBoolean

public boolean toBoolean()

Converts to a boolean.

Overrides:

toBoolean in class Value

isA

public boolean isA(Env env,
                   java.lang.String name)

Returns true for an implementation of a class

Overrides:

isA in class Value

toLong

public long toLong()

Converts to a long.

Overrides:

toLong in class Value

toDouble

public double toDouble()

Converts to a double.

Overrides:

toDouble in class Value

toJavaEnum

public java.lang.Enum toJavaEnum(Env env,
                                 java.lang.Class cls)

Converts to a Java Enum.

Overrides:

toJavaEnum in class Value

toAutoArray

public Value toAutoArray()

Description copied from class: Value

Converts to an array if null.

Overrides:

toAutoArray in class Value

appendTo

public StringValue appendTo(UnicodeBuilderValue sb)

Append to a string builder.

Overrides:

appendTo in class Value

appendTo

public StringValue appendTo(StringBuilderValue sb)

Append to a binary builder.

Overrides:

appendTo in class Value

appendTo

public StringValue appendTo(BinaryBuilderValue sb)

Append to a binary builder.

Overrides:

appendTo in class Value

appendTo

public StringValue appendTo(LargeStringBuilderValue sb)

Append to a binary builder.

Overrides:

appendTo in class Value

get

public Value get(Value key)

Returns the array value with the given key.

Overrides:

get in class Value

put

public Value put(Value key,
                 Value value)

Sets the array value with the given key.

Overrides:

put in class Value

put

public Value put(Value value)

Appends a new array value

Overrides:

put in class Value

append

public Value append(Value index,
                    Value value)

Sets the array value, returning the new array, e.g. to handle string update ($a[0] = 'A'). Creates an array automatically if necessary.

Overrides:

append in class Value

isset

public boolean isset(Value key)

Return true if set

Overrides:

isset in class Value

isEmpty

public boolean isEmpty(Env env,
                       Value key)

Return true if empty.

Overrides:

isEmpty in class Value

remove

public Value remove(Value key)

Unsets the array value

Overrides:

remove in class Value

getIterator

public java.util.Iterator<java.util.Map.Entry<Value,Value>> getIterator(Env env)

Returns an iterator for the key => value pairs.

Overrides:

getIterator in class Value

getKeyIterator

public java.util.Iterator<Value> getKeyIterator(Env env)

Returns an iterator for the keys.

Overrides:

getKeyIterator in class Value

getValueIterator

public java.util.Iterator<Value> getValueIterator(Env env)

Returns an iterator for the values.

Overrides:

getValueIterator in class Value

getCount

public int getCount(Env env)

Returns the count value with the given key.

Overrides:

getCount in class Value

putField

public Value putField(java.lang.String key,
                      java.lang.String value)

Adds a new value.

putField

public Value putField(Env env,
                      java.lang.String key,
                      java.lang.String value)

Adds a new value.

putField

public Value putField(java.lang.String key,
                      long value)

Adds a new value.

putField

public Value putField(Env env,
                      java.lang.String key,
                      long value)

Adds a new value.

putField

public Value putField(Env env,
                      java.lang.String key,
                      Value value)

Adds a new value.

Overrides:

putField in class Value

initField

public void initField(Env env,
                      StringValue name,
                      StringValue canonicalName,
                      Value value)

Initializes a new field, does not call __set if it is defined.

Overrides:

initField in class Value

initIncompleteField

public void initIncompleteField(Env env,
                                StringValue name,
                                Value value,
                                FieldVisibility visibility)

Overrides:

initIncompleteField in class Value

putField

public Value putField(java.lang.String key,
                      double value)

Adds a new value.

getStaticFieldValue

public Value getStaticFieldValue(Env env,
                                 StringValue name)

Returns the static field.

Overrides:

getStaticFieldValue in class Value

getStaticFieldVar

public Var getStaticFieldVar(Env env,
                             StringValue name)

Returns the static field reference.

Overrides:

getStaticFieldVar in class Value

setStaticFieldRef

public Value setStaticFieldRef(Env env,
                               StringValue name,
                               Value value)

Sets the static field.

Overrides:

setStaticFieldRef in class Value

eq

public boolean eq(Value rValue)

Returns true for equality

Overrides:

eq in class Value

cmpObject

public int cmpObject(ObjectValue rValue)

Compare two objects

findFunction

public final AbstractFunction findFunction(StringValue methodName)

Finds the method name.

Overrides:

findFunction in class Value

call

public Value call(Env env,
                  Value[] args)

Call for callable.

Specified by:

call in interface Callable

Specified by:

call in class Callback

Parameters:

env - the calling environment

varDumpObject

public void varDumpObject(Env env,
                          WriteStream out,
                          int depth,
                          java.util.IdentityHashMap<Value,java.lang.String> valueSet)
                   throws java.io.IOException

Throws:

java.io.IOException

jsonEncode

public void jsonEncode(Env env,
                       JsonEncodeContext context,
                       StringValue sb)

Encodes the value in JSON.

Overrides:

jsonEncode in class Value