Modifier and Type	Class and Description
public static interface	ByteUtils.ByteConsumer Used to consume bytes.
public static interface	ByteUtils.ByteSupplier Used to supply bytes.
public static class	ByteUtils.InputStreamByteSupplier Deprecated Unused `ByteSupplier` based on `InputStream`.
public static class	ByteUtils.OutputStreamByteConsumer `ByteConsumer` based on `OutputStream`.

Modifier and Type	Field and Description
public static final byte[]	EMPTY_BYTE_ARRAY Empty array.

Access	Constructor and Description
private	ByteUtils()

Method Summary

Modifier and Type	Method and Description
private static void	checkReadLength(final int length)
public static long	Returns: the number read fromLittleEndian(final byte[] the byte array to convert bytes) Reads the given byte array as a little-endian long.
public static long	Returns: the number read fromLittleEndian(final byte[] the byte array to convert bytes, final int the offset into the array that starts the value off, final int the number of bytes representing the value length) Reads the given byte array as a little-endian long.
public static long	Returns: the number read fromLittleEndian(final ByteUtils.ByteSupplier the supplier for bytes supplier, final int the number of bytes representing the value length) Reads the given number of bytes from the given supplier as a little-endian long.
public static long	Returns: the number read fromLittleEndian(final DataInput the input to read from in, final int the number of bytes representing the value length) Reads the given number of bytes from the given input as little-endian long.
public static long	Returns: the number read fromLittleEndian(final InputStream the stream to read from in, final int the number of bytes representing the value length) Deprecated Unused Reads the given number of bytes from the given stream as a little-endian long.
public static void	toLittleEndian(final byte[] the array to write into b, final long the value to insert value, final int the offset into the array that receives the first byte off, final int the number of bytes to use to represent the value length) Inserts the given value into the array as a little-endian sequence of the given length starting at the given offset.
public static void	toLittleEndian(final ByteUtils.ByteConsumer the consumer to provide the bytes to consumer, final long the value to provide value, final int the number of bytes to use to represent the value length) Provides the given value to the given consumer as a little-endian sequence of the given length.
public static void	toLittleEndian(final DataOutput the output to write to out, final long the value to write value, final int the number of bytes to use to represent the value length) Deprecated Unused Writes the given value to the given stream as a little-endian array of the given length.
public static void	toLittleEndian(final OutputStream the stream to write to out, final long the value to write value, final int the number of bytes to use to represent the value length) Writes the given value to the given stream as a little-endian array of the given length.

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

Field Detail

EMPTY_BYTE_ARRAY	back to summary
public static final byte[] EMPTY_BYTE_ARRAY Empty array. Since 1.21

EMPTY_BYTE_ARRAY

back to summary

public static final byte[] EMPTY_BYTE_ARRAY

Empty array.

Since: 1.21

Constructor Detail

ByteUtils	back to summary
private ByteUtils()

Method Detail

checkReadLength	back to summary
private static void checkReadLength(final int length)

fromLittleEndian	back to summary
public static long fromLittleEndian(final byte[] bytes) Reads the given byte array as a little-endian long. Parameters bytes:byte[] the byte array to convert Returns:long the number read

fromLittleEndian

back to summary

public static long fromLittleEndian(final byte[] bytes)

Reads the given byte array as a little-endian long.

Parameters

bytes:byte[]: the byte array to convert

Returns:long

the number read

fromLittleEndian	back to summary
public static long fromLittleEndian(final byte[] bytes, final int off, final int length) Reads the given byte array as a little-endian long. Parameters bytes:byte[] the byte array to convert off:int the offset into the array that starts the value length:int the number of bytes representing the value Returns:long the number read Exceptions IllegalArgumentException: if len is bigger than eight

fromLittleEndian

back to summary

public static long fromLittleEndian(final byte[] bytes, final int off, final int length)

Reads the given byte array as a little-endian long.

Parameters

bytes:byte[]: the byte array to convert
off:int: the offset into the array that starts the value
length:int: the number of bytes representing the value

Returns:long

the number read

Exceptions

IllegalArgumentException:: if len is bigger than eight

fromLittleEndian	back to summary
public static long fromLittleEndian(final ByteUtils.ByteSupplier supplier, final int length) throws IOException Reads the given number of bytes from the given supplier as a little-endian long. Typically used by our InputStreams that need to count the bytes read as well. Parameters supplier:ByteUtils.ByteSupplier the supplier for bytes length:int the number of bytes representing the value Returns:long the number read Exceptions IOException: if the supplier fails or doesn't supply the given number of bytes anymore IllegalArgumentException: if len is bigger than eight

fromLittleEndian

back to summary

public static long fromLittleEndian(final ByteUtils.ByteSupplier supplier, final int length) throws IOException

Reads the given number of bytes from the given supplier as a little-endian long.

Typically used by our InputStreams that need to count the bytes read as well.

Parameters

supplier:ByteUtils.ByteSupplier: the supplier for bytes
length:int: the number of bytes representing the value

Returns:long

the number read

Exceptions

IOException:: if the supplier fails or doesn't supply the given number of bytes anymore
IllegalArgumentException:: if len is bigger than eight

fromLittleEndian	back to summary
public static long fromLittleEndian(final DataInput in, final int length) throws IOException Reads the given number of bytes from the given input as little-endian long. Parameters in:DataInput the input to read from length:int the number of bytes representing the value Returns:long the number read Exceptions IOException: if reading fails or the stream doesn't contain the given number of bytes anymore IllegalArgumentException: if len is bigger than eight

fromLittleEndian

back to summary

public static long fromLittleEndian(final DataInput in, final int length) throws IOException

Reads the given number of bytes from the given input as little-endian long.

Parameters

in:DataInput: the input to read from
length:int: the number of bytes representing the value

Returns:long

the number read

Exceptions

IOException:: if reading fails or the stream doesn't contain the given number of bytes anymore
IllegalArgumentException:: if len is bigger than eight

fromLittleEndian	back to summary
public static long fromLittleEndian(final InputStream in, final int length) throws IOException Deprecated Unused Reads the given number of bytes from the given stream as a little-endian long. Parameters in:InputStream the stream to read from length:int the number of bytes representing the value Returns:long the number read Annotations @Deprecated Exceptions IOException: if reading fails or the stream doesn't contain the given number of bytes anymore IllegalArgumentException: if len is bigger than eight

fromLittleEndian

back to summary

public static long fromLittleEndian(final InputStream in, final int length) throws IOException

Deprecated

Unused

Reads the given number of bytes from the given stream as a little-endian long.

Parameters

in:InputStream: the stream to read from
length:int: the number of bytes representing the value

Returns:long

the number read

Annotations

@Deprecated

Exceptions

IOException:: if reading fails or the stream doesn't contain the given number of bytes anymore
IllegalArgumentException:: if len is bigger than eight

toLittleEndian	back to summary
public static void toLittleEndian(final byte[] b, final long value, final int off, final int length) Inserts the given value into the array as a little-endian sequence of the given length starting at the given offset. Parameters b:byte[] the array to write into value:long the value to insert off:int the offset into the array that receives the first byte length:int the number of bytes to use to represent the value

toLittleEndian

back to summary

public static void toLittleEndian(final byte[] b, final long value, final int off, final int length)

Inserts the given value into the array as a little-endian sequence of the given length starting at the given offset.

Parameters

b:byte[]: the array to write into
value:long: the value to insert
off:int: the offset into the array that receives the first byte
length:int: the number of bytes to use to represent the value

toLittleEndian	back to summary
public static void toLittleEndian(final ByteUtils.ByteConsumer consumer, final long value, final int length) throws IOException Provides the given value to the given consumer as a little-endian sequence of the given length. Parameters consumer:ByteUtils.ByteConsumer the consumer to provide the bytes to value:long the value to provide length:int the number of bytes to use to represent the value Exceptions IOException: if writing fails

toLittleEndian

back to summary

public static void toLittleEndian(final ByteUtils.ByteConsumer consumer, final long value, final int length) throws IOException

Provides the given value to the given consumer as a little-endian sequence of the given length.

Parameters

consumer:ByteUtils.ByteConsumer: the consumer to provide the bytes to
value:long: the value to provide
length:int: the number of bytes to use to represent the value

Exceptions

IOException:: if writing fails

toLittleEndian	back to summary
public static void toLittleEndian(final DataOutput out, final long value, final int length) throws IOException Deprecated Unused Writes the given value to the given stream as a little-endian array of the given length. Parameters out:DataOutput the output to write to value:long the value to write length:int the number of bytes to use to represent the value Annotations @Deprecated Exceptions IOException: if writing fails

toLittleEndian

back to summary

public static void toLittleEndian(final DataOutput out, final long value, final int length) throws IOException

Deprecated

Unused

Writes the given value to the given stream as a little-endian array of the given length.

Parameters

out:DataOutput: the output to write to
value:long: the value to write
length:int: the number of bytes to use to represent the value

Annotations

@Deprecated

Exceptions

IOException:: if writing fails

toLittleEndian	back to summary
public static void toLittleEndian(final OutputStream out, final long value, final int length) throws IOException Writes the given value to the given stream as a little-endian array of the given length. Parameters out:OutputStream the stream to write to value:long the value to write length:int the number of bytes to use to represent the value Exceptions IOException: if writing fails

toLittleEndian

back to summary

public static void toLittleEndian(final OutputStream out, final long value, final int length) throws IOException

Writes the given value to the given stream as a little-endian array of the given length.

Parameters

out:OutputStream: the stream to write to
value:long: the value to write
length:int: the number of bytes to use to represent the value

Exceptions

IOException:: if writing fails

org.apache.commons.compress.utils back to summary

public Interface ByteUtils.ByteConsumer

Known Direct Implementers: org.apache.commons.compress.utils.ByteUtils.OutputStreamByteConsumer

Used to consume bytes.

Since: 1.14

Method Summary

Modifier and Type	Method and Description
public void	accept(int the byte to consume b) The contract is similar to `OutputStream#write(int)`, consume the lower eight bytes of the int as a byte.

Method Detail

accept back to summary

accept	back to summary
public void accept(int b) throws IOException The contract is similar to `OutputStream#write(int)`, consume the lower eight bytes of the int as a byte. Parameters b:int the byte to consume Exceptions IOException: if consuming fails

public void accept(int b) throws IOException

The contract is similar to OutputStream#write(int), consume the lower eight bytes of the int as a byte.

Parameters

b:int: the byte to consume

Exceptions

IOException:: if consuming fails

org.apache.commons.compress.utils back to summary

public Interface ByteUtils.ByteSupplier

Known Direct Implementers: org.apache.commons.compress.utils.ByteUtils.InputStreamByteSupplier

Used to supply bytes.

Since: 1.14

Method Summary

Modifier and Type	Method and Description
public int	Returns: the supplied byte or -1 if there are no more bytes getAsByte() The contract is similar to `InputStream#read()`, return the byte as an unsigned int, -1 if there are no more bytes.

Method Detail

getAsByte back to summary

getAsByte	back to summary
public int getAsByte() throws IOException The contract is similar to `InputStream#read()`, return the byte as an unsigned int, -1 if there are no more bytes. Returns:int the supplied byte or -1 if there are no more bytes Exceptions IOException: if supplying fails

public int getAsByte() throws IOException

The contract is similar to InputStream#read(), return the byte as an unsigned int, -1 if there are no more bytes.

Returns:int

the supplied byte or -1 if there are no more bytes

Exceptions

IOException:: if supplying fails

org.apache.commons.compress.utils back to summary

public Class ByteUtils.InputStreamByteSupplier

Class Inheritance

extends Object
implements ByteSupplier

java.lang.Object
org.apache.commons.compress.utils.ByteUtils.InputStreamByteSupplier

All Implemented Interfaces

org.apache.commons.compress.utils.ByteUtils.ByteSupplier

Annotations

@Deprecated

Deprecated

Unused

ByteSupplier based on InputStream.

Since: 1.14

Field Summary

Modifier and Type	Field and Description
private final InputStream	is

Constructor Summary

Access	Constructor and Description
public	InputStreamByteSupplier(final InputStream is)

Method Summary

Modifier and Type	Method and Description
public int	getAsByte() Implements org.apache.commons.compress.utils.ByteUtils.ByteSupplier.getAsByte. The contract is similar to `InputStream#read()`, return the byte as an unsigned int, -1 if there are no more bytes.

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

Field Detail

is	back to summary
private final InputStream is

Constructor Detail

InputStreamByteSupplier	back to summary
public InputStreamByteSupplier(final InputStream is)

Method Detail

getAsByte back to summary

getAsByte	back to summary
public int getAsByte() throws IOException Implements org.apache.commons.compress.utils.ByteUtils.ByteSupplier.getAsByte. Doc from org.apache.commons.compress.utils.ByteUtils.ByteSupplier.getAsByte. The contract is similar to `InputStream#read()`, return the byte as an unsigned int, -1 if there are no more bytes. Returns:int the supplied byte or -1 if there are no more bytes Annotations @Override Exceptions IOException: if supplying fails

public int getAsByte() throws IOException

Implements org.apache.commons.compress.utils.ByteUtils.ByteSupplier.getAsByte.

Doc from org.apache.commons.compress.utils.ByteUtils.ByteSupplier.getAsByte.

The contract is similar to InputStream#read(), return the byte as an unsigned int, -1 if there are no more bytes.

Returns:int

the supplied byte or -1 if there are no more bytes

Annotations

@Override

Exceptions

IOException:: if supplying fails

org.apache.commons.compress.utils back to summary

public Class ByteUtils.OutputStreamByteConsumer

Class Inheritance

extends Object
implements ByteConsumer

java.lang.Object
org.apache.commons.compress.utils.ByteUtils.OutputStreamByteConsumer

All Implemented Interfaces

org.apache.commons.compress.utils.ByteUtils.ByteConsumer

ByteConsumer based on OutputStream.

Since: 1.14

Field Summary

Modifier and Type	Field and Description
private final OutputStream	os

Constructor Summary

Access	Constructor and Description
public	OutputStreamByteConsumer(final OutputStream os)

Method Summary

Modifier and Type	Method and Description
public void	accept(final int the byte to consume b) Implements org.apache.commons.compress.utils.ByteUtils.ByteConsumer.accept. The contract is similar to `OutputStream#write(int)`, consume the lower eight bytes of the int as a byte.

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

Field Detail

os	back to summary
private final OutputStream os

Constructor Detail

OutputStreamByteConsumer	back to summary
public OutputStreamByteConsumer(final OutputStream os)

Method Detail

accept back to summary

accept	back to summary
public void accept(final int b) throws IOException Implements org.apache.commons.compress.utils.ByteUtils.ByteConsumer.accept. Doc from org.apache.commons.compress.utils.ByteUtils.ByteConsumer.accept. The contract is similar to `OutputStream#write(int)`, consume the lower eight bytes of the int as a byte. Parameters b:int the byte to consume Annotations @Override Exceptions IOException: if consuming fails

public void accept(final int b) throws IOException

Implements org.apache.commons.compress.utils.ByteUtils.ByteConsumer.accept.

Doc from org.apache.commons.compress.utils.ByteUtils.ByteConsumer.accept.

The contract is similar to OutputStream#write(int), consume the lower eight bytes of the int as a byte.

Parameters

b:int: the byte to consume

Annotations

@Override

Exceptions

IOException:: if consuming fails

public final Class ByteUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ByteUtils.ByteConsumer

Method Summary

Method Detail

public Interface ByteUtils.ByteSupplier

Method Summary

Method Detail

public Class ByteUtils.InputStreamByteSupplier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ByteUtils.OutputStreamByteConsumer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail