com.sap.cloud.server.odata

Class ByteStream

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.StreamBase

com.sap.cloud.server.odata.ByteStream

Direct Known Subclasses:

MimeStreamReader, MimeStreamWriter

public abstract class ByteStream
extends StreamBase

Abstract base class for byte streams.

Field Summary

Fields

Modifier and Type	Field and Description
static ByteStream	empty

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
ByteStream()

Method Summary

Modifier and Type	Method and Description
CharStream	asText() Assuming this stream is a UTF-8 byte stream, map it to a character stream (of UTF-16 code units).
void	copyTo(ByteStream target) See copyTo(ByteStream, boolean).
void	copyTo(ByteStream target, boolean closeTarget) Copy all remaining data until the end of this stream into a target stream, then close this stream.
void	copyToFile(java.lang.String file) Copy all remaining data until the end of the stream into a file, then close this stream.
static ByteStream	fileWriter(java.lang.String file) Return a stream that will write the contents of a data file.
static ByteStream	fromBinary(byte[] data) See fromBinary(byte[], int, int).
static ByteStream	fromBinary(byte[] data, int offset) See fromBinary(byte[], int, int).
static ByteStream	fromBinary(byte[] data, int offset, int length) Return a new stream for reading from a binary value.
static ByteStream	fromFile(java.lang.String file) Return a stream that will read the contents of a data file.
static ByteStream	fromInput(java.io.InputStream input)
static ByteStream	fromStream(StreamBase stream) Return stream (if stream is a ByteStream) or ByteStream.fromText(stream) (if stream is a CharStream).
static ByteStream	fromText(CharStream stream) Return a new UTF-8 byte stream which reads from an underlying UTF-16 character stream.
boolean	getCanUndo() Return does this stream support ByteStream.undoRead?
DataType	getDataType() Return data type with a DataType.code of DataType.BYTE_STREAM.
byte[]	readAndClose() Read all remaining data until the end of the stream, then close this stream.
byte[]	readBinary() See readBinary(int).
byte[]	readBinary(int length) Read up to length bytes from this stream (may read less, even if the end of stream is not reached).
int	readByte() Read a single byte from this stream.
static ByteStream	toBuffer(com.sap.cloud.server.odata.core.ByteBuffer buffer) Return a new byte stream which writes to a provided buffer.
static java.io.InputStream	toInput(ByteStream stream)
java.lang.String	toString() Convert this data value to a string.
void	undoRead(byte value) Undo read of one byte.
ByteStream	withUndo() Return a wrapper (if needed) of this stream supporting ByteStream.undoRead, or this stream if it already supports undoRead.
void	writeBinary(byte[] data) Write to this stream the portion of data from the specified offset with the specified length.
void	writeByte(byte value) Write a single byte to this stream.

Methods inherited from class com.sap.cloud.server.odata.StreamBase

close, flush, getEntityTag, getFileName, getMediaType, setEntityTag, setFileName, setMediaType

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

empty

public static final ByteStream empty

Constructor Detail

ByteStream

public ByteStream()

Method Detail

fromInput

public static ByteStream fromInput(java.io.InputStream input)

toInput

public static java.io.InputStream toInput(ByteStream stream)

asText

public CharStream asText()

Assuming this stream is a UTF-8 byte stream, map it to a character stream (of UTF-16 code units).

Returns:

New character stream, which reads from this UTF-8 byte stream and converts to UTF-16 code units.

copyTo

public void copyTo(ByteStream target)

See copyTo(ByteStream, boolean).

Parameters:

target - Target parameter.

copyTo

public void copyTo(ByteStream target,
                   boolean closeTarget)

Copy all remaining data until the end of this stream into a target stream, then close this stream. Also propagate the ByteStream.entityTag and ByteStream.mediaType of this stream into the target stream.

Parameters:

target - Output stream.

closeTarget - Close target stream? (defaults to true)

copyToFile

public void copyToFile(java.lang.String file)

Copy all remaining data until the end of the stream into a file, then close this stream.

Parameters:

file - Output file name.

fileWriter

public static ByteStream fileWriter(java.lang.String file)

Return a stream that will write the contents of a data file.

Parameters:

file - Output file name.

Returns:

A stream that will write the contents of a data file.

fromBinary

public static ByteStream fromBinary(byte[] data)

See fromBinary(byte[], int, int).

Parameters:

data - Data parameter.

Returns:

(see linked method).

fromBinary

public static ByteStream fromBinary(byte[] data,
                                    int offset)

See fromBinary(byte[], int, int).

Parameters:

data - Data parameter.

offset - Offset parameter.

Returns:

(see linked method).

fromBinary

public static ByteStream fromBinary(byte[] data,
                                    int offset,
                                    int length)

Return a new stream for reading from a binary value.

Parameters:

data - Source data.

offset - Starting offset (zero-based).

length - Maximum number of bytes to read.

Returns:

A new stream for reading from a binary value.

fromFile

public static ByteStream fromFile(java.lang.String file)

Return a stream that will read the contents of a data file.

Parameters:

file - Input file name.

Returns:

A stream that will read the contents of a data file.

fromStream

public static ByteStream fromStream(StreamBase stream)

Return stream (if stream is a ByteStream) or ByteStream.fromText(stream) (if stream is a CharStream).

Parameters:

stream - Underlying stream.

Returns:

stream (if stream is a ByteStream) or ByteStream.fromText(stream) (if stream is a CharStream).

fromText

public static ByteStream fromText(CharStream stream)

Return a new UTF-8 byte stream which reads from an underlying UTF-16 character stream.

Parameters:

stream - Underlying character stream.

Returns:

A new UTF-8 byte stream which reads from an underlying UTF-16 character stream.

getCanUndo

public boolean getCanUndo()

Return does this stream support ByteStream.undoRead?

See Also:

ByteStream.withUndo.

Returns:

Does this stream support ByteStream.undoRead?

getDataType

public DataType getDataType()

Return data type with a DataType.code of DataType.BYTE_STREAM.

Specified by:

getDataType in class DataValue

Returns:

Data type with a DataType.code of DataType.BYTE_STREAM.

readAndClose

public byte[] readAndClose()

Read all remaining data until the end of the stream, then close this stream. Caution: this function loads all stream content into memory at once. Consider reading a chunk-at-a-time in a loop, using ByteStream.readBinary.

Returns:

The remaining data.

readBinary

public byte[] readBinary()

See readBinary(int).

Returns:

(see linked method).

readBinary

public byte[] readBinary(int length)

Read up to length bytes from this stream (may read less, even if the end of stream is not reached).

Parameters:

length - Maximum number of bytes to read (must be greater than zero). Defaults to 20,000.

Returns:

(nullable) Binary value with at most length bytes, or null if there is no remaining data in the stream.

readByte

public int readByte()

Read a single byte from this stream.

Returns:

Unsigned integer equivalent of the byte read, or -1 at end of stream.

toBuffer

public static ByteStream toBuffer(com.sap.cloud.server.odata.core.ByteBuffer buffer)

Return a new byte stream which writes to a provided buffer.

Parameters:

buffer - Buffer to be written to.

Returns:

A new byte stream which writes to a provided buffer.

toString

public java.lang.String toString()

Convert this data value to a string. If the ByteStream.dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

Specified by:

toString in class DataValue

Returns:

Lexical representation of this data value.

undoRead

public void undoRead(byte value)

Undo read of one byte.

Throws:

DataStreamException if undo is not supported by this stream.

Parameters:

value - Byte value that was previously read by the caller and is to be made available to read again.

withUndo

public ByteStream withUndo()

Return a wrapper (if needed) of this stream supporting ByteStream.undoRead, or this stream if it already supports undoRead.

See Also:

ByteStream.canUndo.

Returns:

A wrapper (if needed) of this stream supporting ByteStream.undoRead, or this stream if it already supports undoRead.

writeBinary

public void writeBinary(byte[] data)

Write to this stream the portion of data from the specified offset with the specified length.

Parameters:

data - Source data.

writeByte

public void writeByte(byte value)

Write a single byte to this stream.

Parameters:

value - Byte value to be written.