Bytes (streaming - parent 1.2.1 API)

All Known Implementing Classes:

AbstractBytes, BigEndianBytes, LittleEndianBytes
```
public interface Bytes
```
This interface is used to define a byte converter for all basic types and some advanced types used in JDK.

Author:

Rick-Rainer Ludwig

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`byte[]`	`empty()`	This method provides a simple empty value.
`static Bytes`	`forByteOrder(ByteOrder byteOrder)`	This method creates a new `Bytes` object for a given `ByteOrder`.
`byte[]`	`fromBoolean(boolean b)`	This method creates a byte array containing the value of the provided boolean.
`byte[]`	`fromByte(byte b)`	This method creates a byte array containing the value of the provided byte.
`byte[]`	`fromDouble(double d)`	This method creates a byte array containing the value of the provided 64bit double.
`byte[]`	`fromFloat(float f)`	This method creates a byte array containing the value of the provided 32bit float.
`byte[]`	`fromHexString(String hexString)`
`byte[]`	`fromInstant(Instant instant)`	This method converts the provided `Instant` into an array of bytes.
`byte[]`	`fromInt(int i)`	This method creates a byte array containing the value of the provided 32bit integer.
`byte[]`	`fromLocalDate(LocalDate localDate)`	This method converts the provided `LocalDate` into an array of bytes.
`byte[]`	`fromLocalDateTime(LocalDateTime localDateTime)`	This method converts the provided `LocalDateTime` into an array of bytes.
`byte[]`	`fromLocalTime(LocalTime localTime)`	This method converts the provided `LocalTime` into an array of bytes.
`byte[]`	`fromLong(long l)`	This method creates a byte array containing the value of the provided 64bit long.
`byte[]`	`fromShort(short s)`	This method creates a byte array containing the value of the provided 16bit short.
`byte[]`	`fromString(String string, Charset charset)`	This method creates a byte array containing the value of the provided string using the charset provided.
`byte[]`	`fromUnsignedByte(int b)`	This method creates a byte array containing the value of the provided unsigned byte.
`byte[]`	`fromUnsignedInt(long i)`	This method creates a byte array containing the value of the provided unsigned 32bit integer.
`byte[]`	`fromUnsignedShort(int s)`	This method creates a byte array containing the value of the provided unsigned 16bit short.
`ByteOrder`	`getByteOrder()`	This method returns the used byte order.
`int`	`putBoolean(byte[] bytes, boolean b, int offset)`	This method writes the provided boolean value into the given byte array.
`int`	`putByte(byte[] bytes, byte b, int offset)`	This method writes the provided byte value into the given byte array.
`int`	`putBytes(byte[] destination, int destinationOffset, byte[] source)`	This method writes a byte array into another array.
`int`	`putDouble(byte[] bytes, double d, int offset)`	This method writes the provided double value into the given byte array.
`int`	`putFloat(byte[] bytes, float f, int offset)`	This method writes the provided float value into the given byte array.
`int`	`putInstant(byte[] bytes, Instant instant, int offset)`	This method writes the provided `Instant` value into the given byte array.
`int`	`putInt(byte[] bytes, int i, int offset)`	This method writes the provided integer value into the given byte array.
`int`	`putLocalDate(byte[] bytes, LocalDate localDate, int offset)`	This method writes the provided `LocalDate` value into the given byte array.
`int`	`putLocalDateTime(byte[] bytes, LocalDateTime l, int offset)`	This method writes the provided `LocalDateTime` value into the given byte array.
`int`	`putLocalTime(byte[] bytes, LocalTime localTime, int offset)`	This method writes the provided `LocalTime` value into the given byte array.
`int`	`putLong(byte[] bytes, long l, int offset)`	This method writes the provided long value into the given byte array.
`int`	`putShort(byte[] bytes, short s, int offset)`	This method writes the provided short value into the given byte array.
`int`	`putUnsignedByte(byte[] bytes, int b, int offset)`	This method writes the provided unsigned byte value into the given byte array.
`int`	`putUnsignedInt(byte[] bytes, long i, int offset)`	This method writes the provided unsigned integer value into the given byte array.
`int`	`putUnsignedShort(byte[] bytes, int s, int offset)`	This method writes the provided unsigned short value into the given byte array.
`boolean`	`toBoolean(byte[] bytes)`
`boolean`	`toBoolean(byte[] bytes, int offset)`
`byte`	`toByte(byte[] bytes)`
`byte`	`toByte(byte[] bytes, int offset)`
`double`	`toDouble(byte[] bytes)`
`double`	`toDouble(byte[] bytes, int offset)`
`float`	`toFloat(byte[] bytes)`
`float`	`toFloat(byte[] bytes, int offset)`
`String`	`toHexString(byte[] bytes)`
`String`	`toHumanReadableString(byte[] bytes)`
`Instant`	`toInstant(byte[] bytes)`	Converts the provided array into a `Instant`.
`Instant`	`toInstant(byte[] bytes, int offset)`	Converts the provided array into a `Instant`.
`int`	`toInt(byte[] bytes)`
`int`	`toInt(byte[] bytes, int offset)`
`LocalDate`	`toLocalDate(byte[] bytes)`	Converts the provided array into a `LocalDate`.
`LocalDate`	`toLocalDate(byte[] bytes, int offset)`	Converts the provided array into a `LocalDate`.
`LocalDateTime`	`toLocalDateTime(byte[] bytes)`	Converts the provided array into a `LocalDateTime`.
`LocalDateTime`	`toLocalDateTime(byte[] bytes, int offset)`	Converts the provided array into a `LocalDateTime`.
`LocalTime`	`toLocalTime(byte[] bytes)`	Converts the provided array into a `LocalTime`.
`LocalTime`	`toLocalTime(byte[] bytes, int offset)`	Converts the provided array into a `LocalTime`.
`long`	`toLong(byte[] bytes)`
`long`	`toLong(byte[] bytes, int offset)`
`short`	`toShort(byte[] bytes)`
`short`	`toShort(byte[] bytes, int offset)`
`String`	`toString(byte[] bytes, Charset charset)`
`int`	`toUnsignedByte(byte[] bytes)`
`int`	`toUnsignedByte(byte[] bytes, int offset)`
`long`	`toUnsignedInt(byte[] bytes)`
`long`	`toUnsignedInt(byte[] bytes, int offset)`
`int`	`toUnsignedShort(byte[] bytes)`
`int`	`toUnsignedShort(byte[] bytes, int offset)`

- Method Detail
  - empty
```
byte[] empty()
```
    This method provides a simple empty value. This value is represented as a byte array of length 0.
    
    Returns:
    
    A zero length byte array is returned.
  - forByteOrder
```
static Bytes forByteOrder(ByteOrder byteOrder)
```
    This method creates a new Bytes object for a given ByteOrder.
    
    Parameters:
    
    byteOrder - is the byte order to be used for reading the input stream.
    
    Returns:
    
    Returns a new Bytes for the byte order provided.
  - getByteOrder
```
ByteOrder getByteOrder()
```
    This method returns the used byte order.
    
    Returns:
    
    A ByteOrder object is returned.
  - putBytes
```
int putBytes(byte[] destination,
             int destinationOffset,
             byte[] source)
      throws IllegalArgumentException
```
    This method writes a byte array into another array.
    
    Parameters:
    
    destination - is the destination array to put the source bytes into.
    
    destinationOffset - is the offset of the destination array where to start writing the bytes.
    
    source - is the array of bytes to be written.
    
    Returns:
    
    The length of the source is returned.
    
    Throws:
    
    IllegalArgumentException - is thrown if the remaining destination bytes in the destination array is too small for the bytes from source.
  - fromBoolean
```
byte[] fromBoolean(boolean b)
```
    This method creates a byte array containing the value of the provided boolean.
    
    Parameters:
    
    b - is the boolean to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putBoolean
```
int putBoolean(byte[] bytes,
               boolean b,
               int offset)
```
    This method writes the provided boolean value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    b - is the boolean to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (1 byte) which were written into the array are returned.
  - toBoolean
```
boolean toBoolean(byte[] bytes)
```
  - toBoolean
```
boolean toBoolean(byte[] bytes,
                  int offset)
```
  - fromByte
```
byte[] fromByte(byte b)
```
    This method creates a byte array containing the value of the provided byte.
    
    Parameters:
    
    b - is the byte to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putByte
```
int putByte(byte[] bytes,
            byte b,
            int offset)
```
    This method writes the provided byte value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    b - is the byte to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (1 byte) which were written into the array are returned.
  - toByte
```
byte toByte(byte[] bytes)
```
  - toByte
```
byte toByte(byte[] bytes,
            int offset)
```
  - fromUnsignedByte
```
byte[] fromUnsignedByte(int b)
```
    This method creates a byte array containing the value of the provided unsigned byte.
    
    Parameters:
    
    b - is the unsigned byte to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putUnsignedByte
```
int putUnsignedByte(byte[] bytes,
                    int b,
                    int offset)
```
    This method writes the provided unsigned byte value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    b - is the unsigned byte to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (1 byte) which were written into the array are returned.
  - toUnsignedByte
```
int toUnsignedByte(byte[] bytes)
```
  - toUnsignedByte
```
int toUnsignedByte(byte[] bytes,
                   int offset)
```
  - fromShort
```
byte[] fromShort(short s)
```
    This method creates a byte array containing the value of the provided 16bit short.
    
    Parameters:
    
    s - is the short to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putShort
```
int putShort(byte[] bytes,
             short s,
             int offset)
```
    This method writes the provided short value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    s - is the short to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (2 bytes) which were written into the array are returned.
  - toShort
```
short toShort(byte[] bytes)
```
  - toShort
```
short toShort(byte[] bytes,
              int offset)
```
  - fromUnsignedShort
```
byte[] fromUnsignedShort(int s)
```
    This method creates a byte array containing the value of the provided unsigned 16bit short.
    
    Parameters:
    
    s - is the unsigned short to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putUnsignedShort
```
int putUnsignedShort(byte[] bytes,
                     int s,
                     int offset)
```
    This method writes the provided unsigned short value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    s - is the unsigned short to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (2 bytes) which were written into the array are returned.
  - toUnsignedShort
```
int toUnsignedShort(byte[] bytes)
```
  - toUnsignedShort
```
int toUnsignedShort(byte[] bytes,
                    int offset)
```
  - fromInt
```
byte[] fromInt(int i)
```
    This method creates a byte array containing the value of the provided 32bit integer.
    
    Parameters:
    
    i - is the integer to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putInt
```
int putInt(byte[] bytes,
           int i,
           int offset)
```
    This method writes the provided integer value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    i - is the integer to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (4 bytes) which were written into the array are returned.
  - toInt
```
int toInt(byte[] bytes)
```
  - toInt
```
int toInt(byte[] bytes,
          int offset)
```
  - fromUnsignedInt
```
byte[] fromUnsignedInt(long i)
```
    This method creates a byte array containing the value of the provided unsigned 32bit integer.
    
    Parameters:
    
    i - is the unsigned integer to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putUnsignedInt
```
int putUnsignedInt(byte[] bytes,
                   long i,
                   int offset)
```
    This method writes the provided unsigned integer value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    i - is the unsigned integer to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (4 bytes) which were written into the array are returned.
  - toUnsignedInt
```
long toUnsignedInt(byte[] bytes)
```
  - toUnsignedInt
```
long toUnsignedInt(byte[] bytes,
                   int offset)
```
  - fromLong
```
byte[] fromLong(long l)
```
    This method creates a byte array containing the value of the provided 64bit long.
    
    Parameters:
    
    l - is the long to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putLong
```
int putLong(byte[] bytes,
            long l,
            int offset)
```
    This method writes the provided long value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    l - is the long to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (8 bytes) which were written into the array are returned.
  - toLong
```
long toLong(byte[] bytes)
```
  - toLong
```
long toLong(byte[] bytes,
            int offset)
```
  - fromFloat
```
byte[] fromFloat(float f)
```
    This method creates a byte array containing the value of the provided 32bit float.
    
    Parameters:
    
    f - is the float to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putFloat
```
int putFloat(byte[] bytes,
             float f,
             int offset)
```
    This method writes the provided float value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    f - is the float to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (4 bytes) which were written into the array are returned.
  - toFloat
```
float toFloat(byte[] bytes)
```
  - toFloat
```
float toFloat(byte[] bytes,
              int offset)
```
  - fromDouble
```
byte[] fromDouble(double d)
```
    This method creates a byte array containing the value of the provided 64bit double.
    
    Parameters:
    
    d - is the double to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putDouble
```
int putDouble(byte[] bytes,
              double d,
              int offset)
```
    This method writes the provided double value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    d - is the double to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (8 bytes) which were written into the array are returned.
  - toDouble
```
double toDouble(byte[] bytes)
```
  - toDouble
```
double toDouble(byte[] bytes,
                int offset)
```
  - fromString
```
byte[] fromString(String string,
                  Charset charset)
```
    This method creates a byte array containing the value of the provided string using the charset provided.
    
    Parameters:
    
    string - is the string to be converted.
    
    charset - is a Charset to be used for byte conversion.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - toString
```
String toString(byte[] bytes,
                Charset charset)
```
  - toHumanReadableString
```
String toHumanReadableString(byte[] bytes)
```
  - toHexString
```
String toHexString(byte[] bytes)
```
  - fromHexString
```
byte[] fromHexString(String hexString)
```
  - fromInstant
```
byte[] fromInstant(Instant instant)
```
    This method converts the provided Instant into an array of bytes.
    
    Parameters:
    
    instant - is an Instant to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putInstant
```
int putInstant(byte[] bytes,
               Instant instant,
               int offset)
```
    This method writes the provided Instant value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    instant - is the Instant to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (12 bytes) which were written into the array are returned.
  - toInstant
```
Instant toInstant(byte[] bytes)
```
    Converts the provided array into a Instant.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    Returns:
    
    A Instant is returned containing the value out of the array.
  - toInstant
```
Instant toInstant(byte[] bytes,
                  int offset)
```
    Converts the provided array into a Instant.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    offset - is the offset in the array to start reading from.
    
    Returns:
    
    A Instant is returned containing the value out of the array.
  - fromLocalDate
```
byte[] fromLocalDate(LocalDate localDate)
```
    This method converts the provided LocalDate into an array of bytes.
    
    Parameters:
    
    localDate - is a LocalDate to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putLocalDate
```
int putLocalDate(byte[] bytes,
                 LocalDate localDate,
                 int offset)
```
    This method writes the provided LocalDate value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    localDate - is the LocalDate to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (4 bytes) which were written into the array are returned.
  - toLocalDate
```
LocalDate toLocalDate(byte[] bytes)
```
    Converts the provided array into a LocalDate.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    Returns:
    
    A LocalDate is returned containing the value out of the array.
  - toLocalDate
```
LocalDate toLocalDate(byte[] bytes,
                      int offset)
```
    Converts the provided array into a LocalDate.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    offset - is the offset in the array to start reading from.
    
    Returns:
    
    A LocalDate is returned containing the value out of the array.
  - fromLocalTime
```
byte[] fromLocalTime(LocalTime localTime)
```
    This method converts the provided LocalTime into an array of bytes.
    
    Parameters:
    
    localTime - is a LocalTime to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putLocalTime
```
int putLocalTime(byte[] bytes,
                 LocalTime localTime,
                 int offset)
```
    This method writes the provided LocalTime value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    localTime - is the LocalTime to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (7 bytes) which were written into the array are returned.
  - toLocalTime
```
LocalTime toLocalTime(byte[] bytes)
```
    Converts the provided array into a LocalTime.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    Returns:
    
    A LocalTime is returned containing the value out of the array.
  - toLocalTime
```
LocalTime toLocalTime(byte[] bytes,
                      int offset)
```
    Converts the provided array into a LocalTime.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    offset - is the offset in the array to start reading from.
    
    Returns:
    
    A LocalTime is returned containing the value out of the array.
  - fromLocalDateTime
```
byte[] fromLocalDateTime(LocalDateTime localDateTime)
```
    This method converts the provided LocalDateTime into an array of bytes.
    
    Parameters:
    
    localDateTime - is a LocalDateTime to be converted.
    
    Returns:
    
    A byte array is returned containing the converted value.
  - putLocalDateTime
```
int putLocalDateTime(byte[] bytes,
                     LocalDateTime l,
                     int offset)
```
    This method writes the provided LocalDateTime value into the given byte array.
    
    Parameters:
    
    bytes - is the byte array to write the converted value into.
    
    l - is the LocalDateTime to be converted.
    
    offset - is the offset where to write the converted value to.
    
    Returns:
    
    The number of bytes (11 bytes) which were written into the array are returned.
  - toLocalDateTime
```
LocalDateTime toLocalDateTime(byte[] bytes)
```
    Converts the provided array into a LocalDateTime.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    Returns:
    
    A LocalDateTime is returned containing the value out of the array.
  - toLocalDateTime
```
LocalDateTime toLocalDateTime(byte[] bytes,
                              int offset)
```
    Converts the provided array into a LocalDateTime.
    
    Parameters:
    
    bytes - is the array to be converted.
    
    offset - is the offset in the array to start reading from.
    
    Returns:
    
    A LocalDateTime is returned containing the value out of the array.

Interface Bytes

Method Summary

Method Detail

empty

forByteOrder

getByteOrder

putBytes

fromBoolean

putBoolean

toBoolean

toBoolean

fromByte

putByte

toByte

toByte

fromUnsignedByte

putUnsignedByte

toUnsignedByte

toUnsignedByte

fromShort

putShort

toShort

toShort

fromUnsignedShort

putUnsignedShort

toUnsignedShort

toUnsignedShort

fromInt

putInt

toInt

toInt

fromUnsignedInt

putUnsignedInt

toUnsignedInt

toUnsignedInt

fromLong

putLong

toLong

toLong

fromFloat

putFloat

toFloat

toFloat

fromDouble

putDouble

toDouble

toDouble

fromString

toString

toHumanReadableString

toHexString

fromHexString

fromInstant

putInstant

toInstant

toInstant

fromLocalDate

putLocalDate

toLocalDate

toLocalDate

fromLocalTime

putLocalTime

toLocalTime

toLocalTime

fromLocalDateTime

putLocalDateTime

toLocalDateTime

toLocalDateTime