com.brightech.xmp.js

Class CollectionWrapper

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.CollectionWrapper

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.Wrapper

Direct Known Subclasses:

AltWrapper, BagWrapper, SeqWrapper

public class CollectionWrapper
extends MBScriptableObject
implements org.mozilla.javascript.Wrapper

Super class for collection wrappers.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
CollectionWrapper() Default Constructor (for rhino).

Method Summary

Modifier and Type	Method and Description
CollectionWrapper	(JavaScript Function) addItem(java.lang.Object theValue) Appends the specified element to the collection.
boolean	(JavaScript Function) contains(java.lang.Object theValue) Test collection to see if it contains a specified value.
int	(JavaScript Function) indexOf(java.lang.Object theValue) Returns the index of the value in the collection.
boolean	(JavaScript Function) isEmpty() Returns true if empty, false if not.
java.lang.String	(JavaScript Function) toString() Returns the string form of the collection.
CollectionIterator	(JavaScript Getter) iterator() Returns an iterator over the elements in this list in proper sequence.
int	(JavaScript Getter) length() Returns the number of components in the collection.

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mozilla.javascript.Wrapper

unwrap

Constructor Detail

CollectionWrapper

public CollectionWrapper()

Default Constructor (for rhino).

Method Detail

(JavaScript Getter) iterator

public CollectionIterator (JavaScript Getter) iterator()

Returns an iterator over the elements in this list in proper sequence.

Returns:

(JavaScript Function) addItem

public CollectionWrapper (JavaScript Function) addItem(java.lang.Object theValue)
                                     throws MalformedXmpFieldException

Appends the specified element to the collection.

Parameters:

theValue - the element to be appended.

Returns:

the collection.

Throws:

MalformedXmpFieldException

(JavaScript Function) contains

public boolean (JavaScript Function) contains(java.lang.Object theValue)

Test collection to see if it contains a specified value.

Parameters:

theValue - The test value.

Returns:

true if the collection contains the specified value.

(JavaScript Getter) length

public int (JavaScript Getter) length()

Returns the number of components in the collection.

Returns:

the number of components in the collection

(JavaScript Function) isEmpty

public boolean (JavaScript Function) isEmpty()

Returns true if empty, false if not.

Returns:

true if empty, false if not.

(JavaScript Function) indexOf

public int (JavaScript Function) indexOf(java.lang.Object theValue)

Returns the index of the value in the collection. Returns -1 if the collection does not contain the value.

Parameters:

theValue -

Returns:

the index of the value inteh collection.

(JavaScript Function) toString

public java.lang.String (JavaScript Function) toString()

Returns the string form of the collection.

Returns:

the string form of the collection.