Binary (IO Utilities 0.4.3 API)

java.lang.Object
- net.morimekta.util.Binary

All Implemented Interfaces:

Serializable, Comparable<Binary>, Stringable
```
public class Binary
extends Object
implements Comparable<Binary>, Stringable, Serializable
```
Simplistic byte sequence wrapper with lots of convenience methods. Used to wrap byte arrays for the binary data type.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Binary(byte[] bytes)
Create a binary instance that wraps a created byte array.

Constructors
Constructor and Description
`Binary(byte[] bytes)` Create a binary instance that wraps a created byte array.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asString()` Make a string representation of the instance value.
`int`	`compareTo(Binary other)`
`static Binary`	`copy(byte[] bytes)` Convenience method to copy a byte array into a byte sequence.
`static Binary`	`copy(byte[] bytes, int off, int len)` Convenience method to copy a part of a byte array into a byte sequence.
`static Binary`	`empty()` Method to create a Binary with 0 bytes.
`boolean`	`equals(Object o)`
`static Binary`	`fromBase64(String base64)` Decode base64 string and wrap the result in a byte sequence.
`static Binary`	`fromHexString(String hex)` Parse a hex string as bytes.
`byte[]`	`get()` Get a copy of the backing array.
`int`	`get(byte[] into)` Get a copy of the backing array.
`ByteBuffer`	`getByteBuffer()` Get a byte buffer wrapping the binary data.
`InputStream`	`getInputStream()` Get an input stream that reads from the stored bytes.
`int`	`hashCode()`
`int`	`length()` Get the length of the backing array.
`static Binary`	`read(InputStream in, int len)` Read a binary buffer from input stream.
`String`	`toBase64()` Get the sequence encoded as base64.
`String`	`toHexString()` Make a hex string from a byte array.
`String`	`toString()`
`static Binary`	`wrap(byte[] bytes)` Convenience method to wrap a byte array into a byte sequence.
`int`	`write(OutputStream out)` Write bytes to output stream.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Binary
```
public Binary(byte[] bytes)
```
    Create a binary instance that wraps a created byte array. Exposed so it can be used in places where constructors are expected.
    
    Parameters:
    
    bytes - The byte array to wrap.
- Method Detail
  - wrap
```
public static Binary wrap(byte[] bytes)
```
    Convenience method to wrap a byte array into a byte sequence.
    
    Parameters:
    
    bytes - Bytes to wrap.
    
    Returns:
    
    The wrapped byte sequence.
  - copy
```
public static Binary copy(byte[] bytes)
```
    Convenience method to copy a byte array into a byte sequence.
    
    Parameters:
    
    bytes - Bytes to wrap.
    
    Returns:
    
    The wrapped byte sequence.
  - copy
```
public static Binary copy(byte[] bytes,
                          int off,
                          int len)
```
    Convenience method to copy a part of a byte array into a byte sequence.
    
    Parameters:
    
    bytes - Bytes to wrap.
    
    off - Offset in source bytes to start reading from.
    
    len - Number of bytes to copy.
    
    Returns:
    
    The wrapped byte sequence.
  - empty
```
public static Binary empty()
```
    Method to create a Binary with 0 bytes.
    
    Returns:
    
    Empty Binary object.
  - length
```
public int length()
```
    Get the length of the backing array.
    
    Returns:
    
    Byte count.
  - get
```
public byte[] get()
```
    Get a copy of the backing array.
    
    Returns:
    
    The copy.
  - get
```
public int get(byte[] into)
```
    Get a copy of the backing array.
    
    Parameters:
    
    into - Target ro copy into.
    
    Returns:
    
    Number of bytes written.
  - fromBase64
```
public static Binary fromBase64(String base64)
```
    Decode base64 string and wrap the result in a byte sequence.
    
    Parameters:
    
    base64 - The string to decode.
    
    Returns:
    
    The resulting sequence.
  - toBase64
```
public String toBase64()
```
    Get the sequence encoded as base64.
    
    Returns:
    
    The encoded string.
  - fromHexString
```
public static Binary fromHexString(String hex)
```
    Parse a hex string as bytes.
    
    Parameters:
    
    hex - The hex string.
    
    Returns:
    
    The corresponding bytes.
  - toHexString
```
public String toHexString()
```
    Make a hex string from a byte array.
    
    Returns:
    
    The hex string.
  - getByteBuffer
```
public ByteBuffer getByteBuffer()
```
    Get a byte buffer wrapping the binary data.
    
    Returns:
    
    A byte buffer.
  - getInputStream
```
public InputStream getInputStream()
```
    Get an input stream that reads from the stored bytes.
    
    Returns:
    
    An input stream.
  - read
```
public static Binary read(InputStream in,
                          int len)
                   throws IOException
```
    Read a binary buffer from input stream.
    
    Parameters:
    
    in - Input stream to read.
    
    len - Number of bytes to read.
    
    Returns:
    
    The read bytes.
    
    Throws:
    
    IOException - If unable to read completely what's expected.
  - write
```
public int write(OutputStream out)
          throws IOException
```
    Write bytes to output stream.
    
    Parameters:
    
    out - Stream to write to.
    
    Returns:
    
    Number of bytes written.
    
    Throws:
    
    IOException - When unable to write to stream.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Binary other)
```
    Specified by:
    
    compareTo in interface Comparable<Binary>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asString
```
public String asString()
```
    Description copied from interface: Stringable
    
    Make a string representation of the instance value.
    
    Specified by:
    
    asString in interface Stringable
    
    Returns:
    
    The string representation.

Class Binary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Binary

Method Detail

wrap

copy

copy

empty

length

get

get

fromBase64

toBase64

fromHexString

toHexString

getByteBuffer

getInputStream

read

write

equals

hashCode

compareTo

toString

asString