org.ringojs.wrappers

Class Stream

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.ringojs.wrappers.Stream

All Implemented Interfaces:

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

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

A CommonJS-compliant wrapper around a Java input or output stream. To register Stream as a host object in Rhino call the defineClass() function with this class.

defineClass(org.ringojs.wrappers.Stream);

To create an Stream wrapper around an instance of java.io.InputStream or java.io.OutputStream call the constructor with the stream as argument:

var io = new Stream(javaInputStream);

When passed to a Java method that expects an input or output stream, Stream wrappers are automatically unwrapped. use the unwrap() method to explicitly get the wrapped stream.

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
Stream()
Stream(org.mozilla.javascript.Scriptable scope, Object arg1, Object arg2)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	closed()
void	flush()
String	getClassName() Return the name of the class.
Object	getInputStream()
Object	getOutputStream()
void	init(Object arg1, Object arg2)
Object	jsunwrap()
Object	read(Object limit)
boolean	readable()
int	readInto(Binary bytes, Object start, Object end)
boolean	seekable()
int	skip(int num)
Object	unwrap() Unwrap the object by returning the wrapped value.
boolean	writable()
void	write(Object arg, Object start, Object end)

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, get, 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, has, hasInstance, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, 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, toString, wait, wait, wait

Constructor Detail

Stream

public Stream()

Stream

public Stream(org.mozilla.javascript.Scriptable scope,
              Object arg1,
              Object arg2)

Method Detail

init

@JSConstructor
public void init(Object arg1,
                                Object arg2)

readable

@JSFunction
public boolean readable()

writable

@JSFunction
public boolean writable()

seekable

@JSFunction
public boolean seekable()

read

@JSFunction
public Object read(Object limit)

readInto

@JSFunction
public int readInto(Binary bytes,
                                Object start,
                                Object end)

write

@JSFunction
public void write(Object arg,
                              Object start,
                              Object end)

flush

@JSFunction
public void flush()

skip

@JSFunction
public int skip(int num)

close

@JSFunction
public void close()

closed

@JSFunction
public boolean closed()

jsunwrap

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

getInputStream

@JSGetter
public Object getInputStream()

getOutputStream

@JSGetter
public Object getOutputStream()

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

getClassName

public String getClassName()

Return the name of the class.

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject

Returns:

the class name