Package org.apache.commons.io.input
Class SwappedDataInputStream
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.io.input.ProxyInputStream
org.apache.commons.io.input.SwappedDataInputStream
- All Implemented Interfaces:
Closeable,DataInput,AutoCloseable
DataInput for systems relying on little-endian data formats. When read, values will be changed from little-endian to
big-endian formats for internal usage.
Provenance: Avalon Excalibur (IO)
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.io.input.ProxyInputStream
ProxyInputStream.AbstractBuilder<T,B extends AbstractStreamBuilder<T, B>> -
Field Summary
Fields inherited from class java.io.FilterInputStream
in -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a SwappedDataInputStream. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturnreadByte()!bytereadByte()Invokes the delegate'sread()method.charreadChar()Reads a 2 byte, unsigned, little endian UTF-16 code point.doubleReads an 8 byte, two's complement, little-endian long.floatReads a 4 byte, IEEE 754, little-endian float.voidreadFully(byte[] data) Invokes the delegate'sread(byte[] data, int, int)method.voidreadFully(byte[] data, int offset, int length) Invokes the delegate'sread(byte[] data, int, int)method.intreadInt()Reads a 4 byte, two's complement little-endian integer.readLine()Not currently supported - throwsUnsupportedOperationException.longreadLong()Reads an 8 byte, two's complement little-endian integer.shortReads a 2 byte, two's complement, little-endian integer.intInvokes the delegate'sread()method.intReads a 2 byte, unsigned, little-endian integer.readUTF()Not currently supported - throwsUnsupportedOperationException.intskipBytes(int count) Invokes the delegate'sskip(int)method.Methods inherited from class org.apache.commons.io.input.ProxyInputStream
afterRead, available, beforeRead, close, handleIOException, mark, markSupported, read, read, read, reset, setReference, skip, unwrap
-
Constructor Details
-
SwappedDataInputStream
Constructs a SwappedDataInputStream.- Parameters:
input- InputStream to read from
-
-
Method Details
-
readBoolean
ReturnreadByte()!= 0- Specified by:
readBooleanin interfaceDataInput- Returns:
- false if the byte read is zero, otherwise true
- Throws:
IOException- if an I/O error occurs.EOFException- if an end of file is reached unexpectedly
-
readByte
Invokes the delegate'sread()method.- Specified by:
readBytein interfaceDataInput- Returns:
- the byte read or -1 if the end of stream
- Throws:
IOException- if an I/O error occurs.EOFException- if an end of file is reached unexpectedly
-
readChar
Reads a 2 byte, unsigned, little endian UTF-16 code point.- Specified by:
readCharin interfaceDataInput- Returns:
- the UTF-16 code point read or -1 if the end of stream
- Throws:
IOException- if an I/O error occurs.EOFException- if an end of file is reached unexpectedly
-
readDouble
Reads an 8 byte, two's complement, little-endian long.- Specified by:
readDoublein interfaceDataInput- Returns:
- the read long
- Throws:
IOException- if an I/O error occurs.EOFException- if an end of file is reached unexpectedly
-
readFloat
Reads a 4 byte, IEEE 754, little-endian float.- Specified by:
readFloatin interfaceDataInput- Returns:
- the read float
- Throws:
IOException- if an I/O error occurs.EOFException- if an end of file is reached unexpectedly
-
readFully
Invokes the delegate'sread(byte[] data, int, int)method.- Specified by:
readFullyin interfaceDataInput- Parameters:
data- the buffer to read the bytes into- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readFully
Invokes the delegate'sread(byte[] data, int, int)method.- Specified by:
readFullyin interfaceDataInput- Parameters:
data- the buffer to read the bytes intooffset- The start offsetlength- The number of bytes to read- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readInt
Reads a 4 byte, two's complement little-endian integer.- Specified by:
readIntin interfaceDataInput- Returns:
- the read int
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readLine
Not currently supported - throwsUnsupportedOperationException.- Specified by:
readLinein interfaceDataInput- Returns:
- the line read
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occursUnsupportedOperationException- always
-
readLong
Reads an 8 byte, two's complement little-endian integer.- Specified by:
readLongin interfaceDataInput- Returns:
- the read long
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readShort
Reads a 2 byte, two's complement, little-endian integer.- Specified by:
readShortin interfaceDataInput- Returns:
- the read short
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readUnsignedByte
Invokes the delegate'sread()method.- Specified by:
readUnsignedBytein interfaceDataInput- Returns:
- the byte read or -1 if the end of stream
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readUnsignedShort
Reads a 2 byte, unsigned, little-endian integer.- Specified by:
readUnsignedShortin interfaceDataInput- Returns:
- the read short
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occurs.
-
readUTF
Not currently supported - throwsUnsupportedOperationException.- Specified by:
readUTFin interfaceDataInput- Returns:
- never
- Throws:
EOFException- if an end of file is reached unexpectedlyIOException- if an I/O error occursUnsupportedOperationException- always
-
skipBytes
Invokes the delegate'sskip(int)method.- Specified by:
skipBytesin interfaceDataInput- Parameters:
count- the number of bytes to skip- Returns:
- the number of bytes skipped or -1 if the end of stream
- Throws:
IOException- if an I/O error occurs
-