com.sdl.context.resource.api

Class ByteString

java.lang.Object

com.sdl.context.resource.api.ByteString

All Implemented Interfaces:

Serializable

public final class ByteString
extends Object
implements Serializable

ByteString class that is associated with various byte array operations across the project. This class creates a clone of the byte array that is passed as a parameter. This practise is called "defensive copying"

Author:

Korhan Ozturk

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
byte	byteAt(int index) Get the byte on the input index.
static ByteString	from(byte[] bytes) Static factory method creating a ByteString object.
static ByteString	from(ByteArrayOutputStream byteArrayOutputStream) Factory method that creates a ByteString object from byteArrayOutputStream object.
boolean	isEmpty() Is the byte array empty?
int	size() Get the number of bytes in this byte array.
byte[]	toByteArray() Get the copy of the byte array.
InputStream	toInputStream() Get the byte array input stream off the byte array stored.
void	write(OutputStream outputStream) Writes the bytes to the output stream.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static ByteString from(byte[] bytes)

Static factory method creating a ByteString object.

Parameters:

bytes - byte array

Returns:

ByteString object initialized with the clone of the bytes array passed.

byteAt

public byte byteAt(int index)

Get the byte on the input index.

Parameters:

index - index no of the byte to be returned.

Returns:

the byte from specified index.

isEmpty

public boolean isEmpty()

Is the byte array empty?

Returns:

whether the byte array is empty

size

public int size()

Get the number of bytes in this byte array.

Returns:

number of bytes in this byte array.

toByteArray

public byte[] toByteArray()

Get the copy of the byte array.

Returns:

copy of the already initialized byte array.

write

public void write(OutputStream outputStream)
           throws IOException

Writes the bytes to the output stream.

Parameters:

outputStream - that will be used to write the bytes.

Throws:

IOException

from

public static ByteString from(ByteArrayOutputStream byteArrayOutputStream)

Factory method that creates a ByteString object from byteArrayOutputStream object.

Parameters:

byteArrayOutputStream - that will be used to extract the arrays for creating the ByteString object.

Returns:

ByteString object with byte array extracted from byteArrayOutputStream.

toInputStream

public InputStream toInputStream()

Get the byte array input stream off the byte array stored.

Returns:

ByteArrayInputStream object that is created using internalBytes.