com.sap.cloud.server.odata

Class CharStream

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.StreamBase

com.sap.cloud.server.odata.CharStream

public abstract class CharStream
extends StreamBase

Abstract base class for char streams, using UTF-16 code units.

Field Summary

Fields

Modifier and Type	Field and Description
static CharStream	empty

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

undefined

Constructor Summary

Constructors

Constructor and Description
CharStream()

Method Summary

Modifier and Type	Method and Description
void	copyTo(CharStream target) See copyTo(CharStream, boolean).
void	copyTo(CharStream target, boolean closeTarget) Copy all remaining text until the end of this stream into a target stream, then close this stream.
void	copyToFile(java.lang.String file) Copy all remaining text until the end of this stream into a file, then close this stream.
static CharStream	fileWriter(java.lang.String file) Return a stream that will write the contents of a text file.
static CharStream	fromFile(java.lang.String file) Return a stream that will read the contents of a text file.
static CharStream	fromInput(java.io.InputStream input)
static CharStream	fromString(java.lang.String text) See fromString(String, int, int).
static CharStream	fromString(java.lang.String text, int offset) See fromString(String, int, int).
static CharStream	fromString(java.lang.String text, int offset, int length) Return a new stream for reading from a string value.
boolean	getCanUndo() Return does this stream support CharStream.undoRead?
DataType	getDataType() Return data type with a DataType.code of DataType.CHAR_STREAM.
java.lang.String	readAndClose() Read all remaining text until the end of this stream, then close this stream.
int	readChar() Read a single character (UTF-16 code unit) from this stream.
java.lang.String	readLine() Read a line of text content from the stream.
java.lang.String	readString() See readString(int).
java.lang.String	readString(int length) Read up to length characters from this stream (may read less, even if the end of stream is not reached).
static CharStream	toBuffer(com.sap.cloud.server.odata.core.CharBuffer buffer) Return a new byte stream which writes to a provided buffer.
java.lang.String	toString() Convert this data value to a string.
static CharStream	toWriter(java.io.Writer writer)
void	undoRead(char value) Undo read of one character.
CharStream	withUndo() Return a wrapper (if needed) of this stream supporting CharStream.undoRead, or this stream if it already supports undoRead.
void	writeChar(char value) Write a single character to this stream.
void	writeLine(java.lang.String text) Write line content to the stream, followed by a newline character.
void	writeString(java.lang.String text) Write to this stream the portion of text from the specified offset with the specified length.

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 CharStream empty

Constructor Detail

CharStream

public CharStream()

Method Detail

fromInput

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

toWriter

public static CharStream toWriter(java.io.Writer writer)

copyTo

public void copyTo(CharStream target)

See copyTo(CharStream, boolean).

Parameters:

target - Target parameter.

copyTo

public void copyTo(CharStream target,
                   boolean closeTarget)

Copy all remaining text until the end of this stream into a target stream, then close this stream. Also propagate the CharStream.entityTag and CharStream.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 text until the end of this stream into a file, then close this stream.

Parameters:

file - Output file name.

fileWriter

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

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

Parameters:

file - Output file name.

Returns:

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

fromFile

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

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

Parameters:

file - Input file name.

Returns:

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

fromString

public static CharStream fromString(java.lang.String text)

See fromString(String, int, int).

Parameters:

text - Text parameter.

Returns:

(see linked method).

fromString

public static CharStream fromString(java.lang.String text,
                                    int offset)

See fromString(String, int, int).

Parameters:

text - Text parameter.

offset - Offset parameter.

Returns:

(see linked method).

fromString

public static CharStream fromString(java.lang.String text,
                                    int offset,
                                    int length)

Return a new stream for reading from a string value.

Parameters:

text - Source text.

offset - Starting offset (zero-based).

length - Maximum number of characters to read.

Returns:

A new stream for reading from a string value.

getCanUndo

public boolean getCanUndo()

Return does this stream support CharStream.undoRead?

See Also:

CharStream.withUndo.

Returns:

Does this stream support CharStream.undoRead?

getDataType

public DataType getDataType()

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

Specified by:

getDataType in class DataValue

Returns:

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

readAndClose

public java.lang.String readAndClose()

Read all remaining text until the end of this 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 CharStream.readString.

Returns:

The remaining text.

readChar

public int readChar()

Read a single character (UTF-16 code unit) from this stream.

Returns:

Unsigned integer equivalent of the character read (a UTF-16 code unit), or -1 at end of stream.

readLine

public java.lang.String readLine()

Read a line of text content from the stream.

Returns:

(nullable) Text content, or null at end of stream.

readString

public java.lang.String readString()

See readString(int).

Returns:

(see linked method).

readString

public java.lang.String readString(int length)

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

Parameters:

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

Returns:

(nullable) String value with at most length characters, or null if there is no remaining text in the stream.

toBuffer

public static CharStream toBuffer(com.sap.cloud.server.odata.core.CharBuffer 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 CharStream.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(char value)

Undo read of one character.

Throws:

DataStreamException if undo is not supported by this stream.

Parameters:

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

withUndo

public CharStream withUndo()

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

See Also:

CharStream.canUndo.

Returns:

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

writeChar

public void writeChar(char value)

Write a single character to this stream.

Parameters:

value - Character value to be written.

writeLine

public void writeLine(java.lang.String text)

Write line content to the stream, followed by a newline character.

Parameters:

text - Line content.

writeString

public void writeString(java.lang.String text)

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

Parameters:

text - Source text.