com.helger.commons.io

Class ByteArrayWrapper

java.lang.Object

com.helger.commons.io.ByteArrayWrapper

All Implemented Interfaces:

IHasByteArray, IHasInputStream, IHasInputStreamAndReader, IHasSize, Serializable

@MustImplementEqualsAndHashcode
public final class ByteArrayWrapper
extends Object
implements IHasByteArray, Serializable

A straight forward implementation of IHasByteArray

Since:

9.1.3

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByteArrayWrapper(byte[] aBytes, boolean bCopyNeeded) Wrap the whole byte array.
ByteArrayWrapper(byte[] aBytes, int nOfs, int nLength, boolean bCopyNeeded) Wrap the passed byte array or just parts of it.

Method Summary

Modifier and Type	Method and Description
byte[]	bytes()
static ByteArrayWrapper	create(NonBlockingByteArrayOutputStream aBAOS, boolean bCopyNeeded) Wrap the content of a NonBlockingByteArrayOutputStream.
static ByteArrayWrapper	create(String sText, Charset aCharset) Wrap the content of a String in a certain charset.
boolean	equals(Object o)
int	getOffset()
int	hashCode()
boolean	isCopy()
boolean	isEmpty()
boolean	isNotEmpty()
int	size()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getAllBytes, getHexEncoded, getInputStream, hasOffset, isReadMultiple, startsWith, writeTo

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

getBufferedReader, getReader

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

getBufferedInputStream

Constructor Detail

ByteArrayWrapper

public ByteArrayWrapper(@Nonnull
                        byte[] aBytes,
                        boolean bCopyNeeded)

Wrap the whole byte array.

Parameters:

aBytes - The byte array to be wrapped. May not be null.

bCopyNeeded - true to copy it, false to reuse the instance.

ByteArrayWrapper

public ByteArrayWrapper(@Nonnull
                        byte[] aBytes,
                        @Nonnegative
                        int nOfs,
                        @Nonnegative
                        int nLength,
                        boolean bCopyNeeded)

Wrap the passed byte array or just parts of it.

Parameters:

aBytes - The byte array to be wrapped. May not be null.

nOfs - Offset. Must be ≥ 0.

nLength - Length. Must be ≥ 0.

bCopyNeeded - true to copy it, false to reuse the instance.

Method Detail

isCopy

public boolean isCopy()

Specified by:

isCopy in interface IHasByteArray

Returns:

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

bytes

@Nonnull
 @ReturnsMutableObject
public byte[] bytes()

Specified by:

bytes in interface IHasByteArray

Returns:

A reference to the contained byte array. Gives write access to the payload! Never null.

getOffset

@Nonnegative
public int getOffset()

Specified by:

getOffset in interface IHasByteArray

Returns:

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

See Also:

IHasByteArray.bytes(), IHasSize.size()

size

@Nonnegative
public int size()

Specified by:

size in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasByteArray

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

public boolean isNotEmpty()

Specified by:

isNotEmpty in interface IHasByteArray

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()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
 @ReturnsMutableCopy
public static ByteArrayWrapper create(@Nonnull
                                                                      NonBlockingByteArrayOutputStream aBAOS,
                                                                      boolean bCopyNeeded)

Wrap the content of a NonBlockingByteArrayOutputStream.

Parameters:

aBAOS - The output stream to be wrapped. May not be null.

bCopyNeeded - true to copy it (needed if the output stream will be modified afterwards), false to reuse the data (if the output stream will not be modified afterwards).

Returns:

ByteArrayWrapper The created instance. Never null.

Since:

9.2.1

create

@Nonnull
 @ReturnsMutableCopy
public static ByteArrayWrapper create(@Nonnull
                                                                      String sText,
                                                                      @Nonnull
                                                                      Charset aCharset)

Wrap the content of a String in a certain charset.

Parameters:

sText - The String to be wrapped. May not be null.

aCharset - The character set to be used for retrieving the bytes from the string. May not be null.

Returns:

ByteArrayWrapper The created instance. Never null.

Since:

9.2.1