com.github.robtimus.io.stream

Class StreamUtils

java.lang.Object

com.github.robtimus.io.stream.StreamUtils

public final class StreamUtils
extends Object

Utility methods for InputStreams, OutputStreams, Readers and Writers. Some of these are general purpose methods, others can be used for implementing InputStreams, OutputStreams, Readers and Writers.

Author:

Rob Spoor

Method Summary

Modifier and Type	Method and Description
static void	checkOffsetAndLength(byte[] array, int offset, int length) Checks whether or not an offset and length are valid for a byte array.
static void	checkOffsetAndLength(char[] array, int offset, int length) Checks whether or not an offset and length are valid for a character array.
static void	checkOffsetAndLength(CharSequence sequence, int offset, int length) Checks whether or not an offset and length are valid for a character sequence.
static void	checkStartAndEnd(CharSequence sequence, int start, int end) Checks whether or not a start and end index are valid for a character sequence.
static IOException	streamClosedException() Returns an IOException that indicates a stream is closed.

Methods inherited from class java.lang.Object

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

Method Detail

checkOffsetAndLength

public static void checkOffsetAndLength(byte[] array,
                                        int offset,
                                        int length)

Checks whether or not an offset and length are valid for a byte array. This method can be used for checking input for InputStream.read(byte[], int, int) or OutputStream.write(byte[], int, int).

Parameters:

array - The array to check for.

offset - The offset to check, inclusive.

length - The length to check.

Throws:

NullPointerException - If the given array is null.

IndexOutOfBoundsException - If the given offset is negative, the given length is negative, or the given offset and length exceed the given array's length.

checkOffsetAndLength

public static void checkOffsetAndLength(char[] array,
                                        int offset,
                                        int length)

Checks whether or not an offset and length are valid for a character array. This method can be used for checking input for Reader.read(char[], int, int) or Writer.write(char[], int, int).

Parameters:

array - The array to check for.

offset - The offset to check, inclusive.

length - The length to check.

Throws:

NullPointerException - If the given array is null.

IndexOutOfBoundsException - If the given offset is negative, the given length is negative, or the given offset and length exceed the given array's length.

checkOffsetAndLength

public static void checkOffsetAndLength(CharSequence sequence,
                                        int offset,
                                        int length)

Checks whether or not an offset and length are valid for a character sequence. This method can be used for checking input for Writer.write(String, int, int).

Parameters:

sequence - The character sequence to check for.

offset - The offset to check, inclusive.

length - The length to check.

Throws:

NullPointerException - If the given character sequence is null.

IndexOutOfBoundsException - If the given offset is negative, the given length is negative, or the given offset and length exceed the given character sequence's length.

checkStartAndEnd

public static void checkStartAndEnd(CharSequence sequence,
                                    int start,
                                    int end)

Checks whether or not a start and end index are valid for a character sequence. This method can be used for checking input for Writer.append(CharSequence, int, int).

Parameters:

sequence - The character sequence to check for.

start - The start index to check, inclusive.

end - The end index to check, exclusive.

Throws:

NullPointerException - If the given character sequence is null.

IndexOutOfBoundsException - If the given start index is negative, the given end index is larger than the given character sequence's length, or the given start index is larger than the given end index.

streamClosedException

public static IOException streamClosedException()

Returns an IOException that indicates a stream is closed.

Returns:

An IOException that indicates a stream is closed.