com.canto.cumulus

Class OutputDataStream

java.lang.Object

java.io.OutputStream

com.canto.cumulus.OutputDataStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class OutputDataStream
extends java.io.OutputStream
implements java.lang.AutoCloseable

The OutputDataStream object allows you to write bytes to a data stream.

See Also:

Asset.openOutputDataStream(), Asset.openOutputRsrcStream()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with the stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
CumulusSession	getCumulusSession() Returns the current CumulusSession object.
long	getPos() Returns the current position in this output stream.
long	getSize() Returns the number of bytes contained in this output stream.
void	movePos(long delta) Sets the current position in this output stream relative to the current position.
void	setPos(long pos) Sets the current position in this output stream.
void	write(byte[] byteData, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int byteData) Writes the specified byte to this output stream.The general contract for write is that one byte is written to the output stream.

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Method Detail

getCumulusSession

public CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Returns:

the current CumulusSession object

write

public void write(int byteData)

Writes the specified byte to this output stream.The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument byteData. The 24 high-order bits of byteData are ignored.

Specified by:

write in class java.io.OutputStream

Parameters:

byteData - the byte.

write

public void write(byte[] byteData,
         int off,
         int len)

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(byteData, off, len) is that some of the bytes in the array byteData are written to the output stream in order; element byteData[off] is the first byte written and byteData[off+len-1] is the last byte written by this operation.

If off is negative, or len is negative, or off+len is greater than the length of the array byteData, then an IndexOutOfBoundsException is thrown.

Overrides:

write in class java.io.OutputStream

Parameters:

byteData - the data.

off - the start offset in the data.

len - the number of bytes to write.

flush

public void flush()

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

close

public void close()

Closes this output stream and releases any system resources associated with the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

getSize

public long getSize()

Returns the number of bytes contained in this output stream.

Returns:

the number of bytes contained in this output stream.

getPos

public long getPos()

Returns the current position in this output stream.

Returns:

the current position in this output stream.

setPos

public void setPos(long pos)

Sets the current position in this output stream.

Parameters:

pos - the new position relative to the beginning of the stream.

movePos

public void movePos(long delta)

Sets the current position in this output stream relative to the current position.

Parameters:

delta - the new position relative to the current position.