Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.services.io.InputStreamUtil

Modifier and Type	Field and Description
private static final int	SKIP_FRAGMENT_SIZE

Access	Constructor and Description
public	InputStreamUtil()

Method Summary

Modifier and Type	Method and Description
public static void	readFully(InputStream Whence to read in, byte[] The byte array to fill b, int Position in byte array where we should start writing offset, int Number of bytes to read len) Read a number of bytes into an array.
public static int	Returns: the number of bytes read readLoop(InputStream Whence to read in, byte[] The byte array to fill b, int Position in byte array where we should start writing offset, int Number of bytes to read len) Read a number of bytes into an array.
public static int	Returns: the byte readUnsignedByte(InputStream Whence to read a byte in) Read an unsigned byte from an InputStream, throwing an EOFException if the end of the input is reached.
public static void	skipFully(InputStream InputStream to be skipped. is, long number of bytes to skip. if skippedBytes >= zero, do nothing. skippedBytes) Skips requested number of bytes, throws EOFException if there is too few bytes in the stream.
public static final long	Returns: The number of bytes skipped. skipPersistent(InputStream byte stream in, long the number of bytes to skip bytesToSkip) Tries harder to skip the requested number of bytes.
public static long	Returns: number of bytes skipped in fact. skipUntilEOF(InputStream InputStream to be skipped. is) Skips until EOF, returns number of bytes skipped.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

SKIP_FRAGMENT_SIZE	back to summary
private static final int SKIP_FRAGMENT_SIZE

InputStreamUtil	back to summary
public InputStreamUtil()

Method Detail

readFully back to summary

readFully	back to summary
public static void readFully(InputStream in, byte[] b, int offset, int len) throws IOException Read a number of bytes into an array. Parameters in:InputStream Whence to read b:byte[] The byte array to fill offset:int Position in byte array where we should start writing len:int Number of bytes to read Exceptions IOException: if an I/O error occurs. EOFException: if the end of the stream is reached See Also `DataInput#readFully`

public static void readFully(InputStream in, byte[] b, int offset, int len) throws IOException

Read a number of bytes into an array.

Parameters

in:InputStream: Whence to read
b:byte[]: The byte array to fill
offset:int: Position in byte array where we should start writing
len:int: Number of bytes to read

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if the end of the stream is reached

See Also

DataInput#readFully

readLoop	back to summary
public static int readLoop(InputStream in, byte[] b, int offset, int len) throws IOException Read a number of bytes into an array. Keep reading in a loop until len bytes are read or EOF is reached or an exception is thrown. Return the number of bytes read. (InputStream.read(byte[],int,int) does not guarantee to read len bytes even if it can do so without reaching EOF or raising an exception.) Parameters in:InputStream Whence to read b:byte[] The byte array to fill offset:int Position in byte array where we should start writing len:int Number of bytes to read Returns:int the number of bytes read Exceptions IOException: if an I/O error occurs.

readLoop

back to summary

public static int readLoop(InputStream in, byte[] b, int offset, int len) throws IOException

Read a number of bytes into an array. Keep reading in a loop until len bytes are read or EOF is reached or an exception is thrown. Return the number of bytes read. (InputStream.read(byte[],int,int) does not guarantee to read len bytes even if it can do so without reaching EOF or raising an exception.)

Parameters

in:InputStream: Whence to read
b:byte[]: The byte array to fill
offset:int: Position in byte array where we should start writing
len:int: Number of bytes to read

Returns:int

the number of bytes read

Exceptions

IOException:: if an I/O error occurs.

readUnsignedByte back to summary

readUnsignedByte	back to summary
public static int readUnsignedByte(InputStream in) throws IOException Read an unsigned byte from an InputStream, throwing an EOFException if the end of the input is reached. Parameters in:InputStream Whence to read a byte Returns:int the byte Exceptions IOException: if an I/O error occurs. EOFException: if the end of the stream is reached See Also `DataInput#readUnsignedByte`

public static int readUnsignedByte(InputStream in) throws IOException

Read an unsigned byte from an InputStream, throwing an EOFException if the end of the input is reached.

Parameters

in:InputStream: Whence to read a byte

Returns:int

the byte

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if the end of the stream is reached

See Also

DataInput#readUnsignedByte

skipFully	back to summary
public static void skipFully(InputStream is, long skippedBytes) throws IOException Skips requested number of bytes, throws EOFException if there is too few bytes in the stream. Parameters is:InputStream InputStream to be skipped. skippedBytes:long number of bytes to skip. if skippedBytes >= zero, do nothing. Exceptions IOException: if IOException occurs. It doesn't contain EOFException. EOFException: if EOF meets before requested number of bytes are skipped. NullPointerException: if the param 'is' equals null.

skipFully

back to summary

public static void skipFully(InputStream is, long skippedBytes) throws IOException

Skips requested number of bytes, throws EOFException if there is too few bytes in the stream.

Parameters

is:InputStream: InputStream to be skipped.
skippedBytes:long: number of bytes to skip. if skippedBytes >= zero, do nothing.

Exceptions

IOException:: if IOException occurs. It doesn't contain EOFException.
EOFException:: if EOF meets before requested number of bytes are skipped.
NullPointerException:: if the param 'is' equals null.

skipPersistent	back to summary
public static final long skipPersistent(InputStream in, long bytesToSkip) throws IOException Tries harder to skip the requested number of bytes. Note that even if the method fails to skip the requested number of bytes, it will not throw an exception. If this happens, the caller can be sure that end-of-stream has been reached. Parameters in:InputStream byte stream bytesToSkip:long the number of bytes to skip Returns:long The number of bytes skipped. Exceptions IOException: if reading from the stream fails

skipPersistent

back to summary

public static final long skipPersistent(InputStream in, long bytesToSkip) throws IOException

Tries harder to skip the requested number of bytes.

Note that even if the method fails to skip the requested number of bytes, it will not throw an exception. If this happens, the caller can be sure that end-of-stream has been reached.

Parameters

in:InputStream: byte stream
bytesToSkip:long: the number of bytes to skip

Returns:long

The number of bytes skipped.

Exceptions

IOException:: if reading from the stream fails

skipUntilEOF	back to summary
public static long skipUntilEOF(InputStream is) throws IOException Skips until EOF, returns number of bytes skipped. Parameters is:InputStream InputStream to be skipped. Returns:long number of bytes skipped in fact. Exceptions IOException: if IOException occurs. It doesn't contain EOFException. NullPointerException: if the param 'is' equals null.

skipUntilEOF

back to summary

public static long skipUntilEOF(InputStream is) throws IOException

Skips until EOF, returns number of bytes skipped.

Parameters

is:InputStream: InputStream to be skipped.

Returns:long

number of bytes skipped in fact.

Exceptions

IOException:: if IOException occurs. It doesn't contain EOFException.
NullPointerException:: if the param 'is' equals null.

public final Class InputStreamUtil

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail