Package com.helger.commons.io

Interface IHasByteArray

All Superinterfaces:

IHasInputStream, IHasInputStreamAndReader, IHasSize

All Known Implementing Classes:

ByteArrayInputStreamProvider, ByteArrayWrapper, ReadableResourceByteArray, ReadableResourceString

public interface IHasByteArray
extends IHasSize, IHasInputStreamAndReader

Base interface for all objects owning a byte array.

Since:

9.1.3

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
byte[]	bytes()
default byte[]	getAllBytes()
default String	getBytesAsString(Charset aCharset)
default String	getHexEncoded()
default InputStream	getInputStream()	Get the input stream to read from the object.
int	getOffset()
default boolean	hasOffset()
boolean	isCopy()
default boolean	isEmpty()
default boolean	isNotEmpty()
default boolean	isReadMultiple()	Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.
default boolean	startsWith(byte[] aCmpBytes)	Check if the passed byte array starts with the bytes of this object.
default void	writeTo(OutputStream aOS)	Write the relevant part of the byte array onto the provided output stream.

Methods inherited from interface com.helger.commons.io.IHasInputStream

getBufferedInputStream

Methods inherited from interface com.helger.commons.io.IHasInputStreamAndReader

getBufferedReader, getReader

Methods inherited from interface com.helger.commons.lang.IHasSize

size

Method Detail

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size(), IHasSize.isNotEmpty()

isNotEmpty

default boolean isNotEmpty()

Specified by:

isNotEmpty in interface IHasSize

Returns:

true if at least one item is present, false if no item is present.

See Also:

IHasSize.size(), IHasSize.isEmpty()

isCopy

boolean isCopy()

Returns:

true if the contained byte array was copied in the constructor or not.

getAllBytes

@Nonnull
@ReturnsMutableCopy
default byte[] getAllBytes()

Returns:

A copy of all bytes contained, from getOffset() for IHasSize.size() bytes. Never null.

bytes

@Nonnull
@ReturnsMutableObject
byte[] bytes()

Returns:

A reference to the contained byte array. Gives write access to the payload! Don't forget to apply getOffset() and IHasSize.size(). Never null.

getOffset

@Nonnegative
int getOffset()

Returns:

The offset into the byte array to start reading. This is always 0 when copied. Must be ge; 0.

See Also:

bytes(), IHasSize.size()

hasOffset

default boolean hasOffset()

Returns:

true if an offset is present, false if not.

getInputStream

@Nonnull
default InputStream getInputStream()

Description copied from interface: IHasInputStream

Get the input stream to read from the object. Each time this method is called, a new InputStream needs to be created.

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

isReadMultiple

default boolean isReadMultiple()

Description copied from interface: IHasInputStream

Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.

Specified by:

isReadMultiple in interface IHasInputStream

Returns:

true if the input stream can be acquired more than once, false if not.

writeTo

default void writeTo(@Nonnull @WillNotClose
                     OutputStream aOS)
              throws IOException

Write the relevant part of the byte array onto the provided output stream.

Parameters:

aOS - The output stream to write to. May not be null.

Throws:

IOException - In case of a write error.

startsWith

default boolean startsWith(@Nonnull
                           byte[] aCmpBytes)

Check if the passed byte array starts with the bytes of this object.

Parameters:

aCmpBytes - The bytes to compare to. May not be null.

Returns:

true if the passed bytes start with the bytes in this object.

getHexEncoded

@Nonnull
default String getHexEncoded()

Returns:

The hex encoded version of this string. Never null but maybe empty, if the underlying array length is empty.

getBytesAsString

@Nonnull
default String getBytesAsString(@Nonnull
                                Charset aCharset)

Parameters:

aCharset - The character set to use. May not be null.

Returns:

The byte array converted to a String, honouring getOffset() and IHasSize.size().

Since:

10.1.3