org.ringojs.wrappers

Class Binary

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.ringojs.wrappers.Binary

All Implemented Interfaces:

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

public class Binary
extends org.mozilla.javascript.ScriptableObject
implements org.mozilla.javascript.Wrapper

A wrapper around a Java byte array compliant to the Binary/ByteArray/ByteString classes defined in the Binary/B proposal. To register Binary, ByteArray and ByteString as a host objects in Rhino call the defineClass() function with this class as argument.

defineClass(org.ringojs.wrappers.Binary);

The JavaScript Binary class serves as common base class for ByteArray and ByteString and can't be instantiated. ByteArray implements a modifiable and resizable byte buffer, while ByteString implements an immutable byte sequence. The ByteArray and ByteString constructors can take several arguments. Have a look at the proposal for details. When passed to a Java method that expects a byte array, instances of thes class are automatically unwrapped.

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
Binary()
Binary(org.ringojs.wrappers.Binary.Type type)
Binary(org.mozilla.javascript.Scriptable scope, org.ringojs.wrappers.Binary.Type type, byte[] bytes)
Binary(org.mozilla.javascript.Scriptable scope, org.ringojs.wrappers.Binary.Type type, byte[] bytes, int offset, int length)
Binary(org.mozilla.javascript.Scriptable scope, org.ringojs.wrappers.Binary.Type type, int length)

Method Summary

Modifier and Type	Method and Description
Object	byteAt(Object index)
Object	charAt(Object index)
Object	charCodeAt(Object index)
static Object	concat(org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable thisObj, Object[] args, org.mozilla.javascript.Function func)
static Object	construct(org.mozilla.javascript.Context cx, Object[] args, org.mozilla.javascript.Function ctorObj, boolean inNewExpr)
void	copy(int srcStartIndex, int srcEndIndex, Binary target, Object targetIndex)
String	decodeToString(Object charset)
protected void	ensureLength(int minLength)
static void	finishInit(org.mozilla.javascript.Scriptable scope, org.mozilla.javascript.FunctionObject ctor, org.mozilla.javascript.Scriptable prototype)
Object	get(int index, org.mozilla.javascript.Scriptable start)
Object	get(Object index)
byte[]	getBytes()
String	getClassName()
int	getLength()
org.ringojs.wrappers.Binary.Type	getType()
boolean	has(int index, org.mozilla.javascript.Scriptable start)
int	indexOf(Object arg, Object from, Object to)
Object	jsunwrap()
int	lastIndexOf(Object arg, Object from, Object to)
void	put(int index, org.mozilla.javascript.Scriptable start, Object value)
void	set(Object index, int value)
protected void	setLength(int newLength)
void	setLength(Object length)
Object	slice(Object begin, Object end)
Object	split(Object delim, Object options)
Object	toArray(Object charset)
Object	toByteArray(Object sourceCharset, Object targetCharset)
Object	toByteString(Object sourceCharset, Object targetCharset)
String	toString()
Object	unwrap() Unwrap the object by returning the wrapped value.
protected static Binary	wrap(org.ringojs.wrappers.Binary.Type type, byte[] bytes, org.mozilla.javascript.Scriptable scope, org.mozilla.javascript.Scriptable prototype)

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, equivalentValues, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasInstance, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

Binary

public Binary()

Binary

public Binary(org.ringojs.wrappers.Binary.Type type)

Binary

public Binary(org.mozilla.javascript.Scriptable scope,
              org.ringojs.wrappers.Binary.Type type,
              int length)

Binary

public Binary(org.mozilla.javascript.Scriptable scope,
              org.ringojs.wrappers.Binary.Type type,
              byte[] bytes)

Binary

public Binary(org.mozilla.javascript.Scriptable scope,
              org.ringojs.wrappers.Binary.Type type,
              byte[] bytes,
              int offset,
              int length)

Method Detail

construct

@JSConstructor
public static Object construct(org.mozilla.javascript.Context cx,
                                              Object[] args,
                                              org.mozilla.javascript.Function ctorObj,
                                              boolean inNewExpr)

finishInit

public static void finishInit(org.mozilla.javascript.Scriptable scope,
                              org.mozilla.javascript.FunctionObject ctor,
                              org.mozilla.javascript.Scriptable prototype)
                       throws NoSuchMethodException

Throws:

NoSuchMethodException

getType

public org.ringojs.wrappers.Binary.Type getType()

get

public Object get(int index,
                  org.mozilla.javascript.Scriptable start)

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class org.mozilla.javascript.ScriptableObject

has

public boolean has(int index,
                   org.mozilla.javascript.Scriptable start)

Specified by:

has in interface org.mozilla.javascript.Scriptable

Overrides:

has in class org.mozilla.javascript.ScriptableObject

put

public void put(int index,
                org.mozilla.javascript.Scriptable start,
                Object value)

Specified by:

put in interface org.mozilla.javascript.Scriptable

Overrides:

put in class org.mozilla.javascript.ScriptableObject

getLength

@JSGetter
public int getLength()

setLength

@JSSetter
public void setLength(Object length)

setLength

protected void setLength(int newLength)

get

@JSFunction
public Object get(Object index)

Overrides:

get in class org.mozilla.javascript.ScriptableObject

charCodeAt

@JSFunction
public Object charCodeAt(Object index)

byteAt

@JSFunction
public Object byteAt(Object index)

charAt

@JSFunction
public Object charAt(Object index)

set

@JSFunction
public void set(Object index,
                            int value)

toByteArray

@JSFunction
public Object toByteArray(Object sourceCharset,
                                      Object targetCharset)
                               throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

toByteString

@JSFunction
public Object toByteString(Object sourceCharset,
                                       Object targetCharset)
                                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

copy

@JSFunction
public void copy(int srcStartIndex,
                             int srcEndIndex,
                             Binary target,
                             Object targetIndex)

toArray

@JSFunction
public Object toArray(Object charset)
                           throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

toString

@JSFunction
public String toString()

Overrides:

toString in class Object

slice

@JSFunction
public Object slice(Object begin,
                                Object end)

concat

@JSFunction
public static Object concat(org.mozilla.javascript.Context cx,
                                        org.mozilla.javascript.Scriptable thisObj,
                                        Object[] args,
                                        org.mozilla.javascript.Function func)

decodeToString

@JSFunction
public String decodeToString(Object charset)

indexOf

@JSFunction
public int indexOf(Object arg,
                               Object from,
                               Object to)

lastIndexOf

@JSFunction
public int lastIndexOf(Object arg,
                                   Object from,
                                   Object to)

split

@JSFunction
public Object split(Object delim,
                                Object options)

wrap

protected static Binary wrap(org.ringojs.wrappers.Binary.Type type,
                             byte[] bytes,
                             org.mozilla.javascript.Scriptable scope,
                             org.mozilla.javascript.Scriptable prototype)

jsunwrap

@JSFunction(value="unwrap")
public Object jsunwrap()

unwrap

public Object unwrap()

Unwrap the object by returning the wrapped value.

Specified by:

unwrap in interface org.mozilla.javascript.Wrapper

Returns:

a wrapped value

getBytes

public byte[] getBytes()

getClassName

public String getClassName()

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject

ensureLength

protected void ensureLength(int minLength)