Bytes (common_tools 3.8.7 API)

java.lang.Object
- net.sergeych.utils.Bytes

All Implemented Interfaces:

java.io.Serializable
```
public class Bytes
extends java.lang.Object
implements java.io.Serializable
```
Wrap for byte[] utility class. Allow usage as an HashMap key. Very effective construction from byte[] and back (toArray() - no copying.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Bytes(byte[]... arrays)`
`Bytes(java.io.ByteArrayOutputStream bos)` Construct from `ByteArrayOutputStream.toByteArray()` bytes
`Bytes(java.io.InputStream in, int length)` Construct by reading certain number of bytes, or all of them, from a stream.
`Bytes(int size)` Create zero-filled instance of the specified size
`Bytes(java.lang.String string)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bytes`	`concatenate(byte[] otherBytes)` Return new buffer that is a concatenation of this and other.
`Bytes`	`concatenate(Bytes other)` Return new buffer that is a concatenation of this and other.
`<T> Bytes`	`concatenate(java.util.List<T> other)`
`Bytes`	`concatenate(java.lang.String s)`
`Bytes`	`correctIntFromGMP()`
`void`	`dump()` Writes dump to standard output, in the same format as `toDump(byte[])`
`static void`	`dump(byte[] data)` Writes dump into standrd output.
`boolean`	`empty()` Check whether that the buffer is empty
`boolean`	`equals(java.lang.Object obj)`
`Bytes`	`fillRandom(int length)` Return new block that is contcatenation of this block and length random bytes
`Bytes`	`flipSelf()` Reverse order of own bytes.
`static Bytes`	`fromBase64(java.lang.String baseStr)` Decode Base64 string into Bytes instance
`static Bytes`	`fromBigInt(java.math.BigInteger value)`
`static Bytes`	`fromDouble(double value)` Create buffer as standard IEEE double(8) representation, little-endian.
`static Bytes`	`fromHex(java.lang.String hex)` Construct from hexadecimal string.
`static Bytes`	`fromString(java.lang.String str)`
`byte[]`	`getData()`
`int`	`hashCode()`
`static byte[]`	`hexToByteArray(java.lang.String hex)` Convert HEX string (ignoring whitespaces) to a byte[]
`java.lang.String`	`inspect()` Tries to convert bytes to UTF8 string.
`Bytes`	`padToSize(int size, int fillByte)` Return new Bytes instance padded to the required size.
`Bytes`	`part(int start)` Extract part of the data from ith index (inclusive) to the end.
`Bytes`	`part(int start, int length)` Extract a part of bytes into new instance.
`static Bytes`	`random(int length)` Create random bytes using `SecureRandom` RNG in SHA1PRNG mode.
`Bytes`	`reverse()` Create a copy with this data in reverse order
`Bytes`	`sha1()`
`Bytes`	`sha256(java.lang.Object... chunks)` Calculate SHA256 hash for this instance optionally with any number of additional chinks.
`int`	`size()`
`byte[]`	`toArray()` return underlying bytes.
`java.lang.String`	`toBase64()`
`java.lang.String`	`toBase64Lines()`
`java.math.BigInteger`	`toBigInteger()` Convert to a BigInteger value.
`java.lang.Object`	`toDouble()`
`java.lang.String`	`toDump()`
`static java.lang.String[]`	`toDump(byte[] data)` Generate dump string with address, hex bytes and ASCII character areas, line endings are "\n"s.
`java.lang.String`	`toHex()`
`java.lang.String`	`toHex(boolean useSpaces)`
`static java.lang.String`	`toHex(byte[] data)`
`java.io.ByteArrayInputStream`	`toInputStream()` Get an input stream to read contents of this buffer
`java.lang.String`	`toString()`
`void`	`write(java.io.OutputStream out)`

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

- Constructor Detail
  - Bytes
```
public Bytes(java.lang.String string)
```
  - Bytes
```
public Bytes(byte[]... arrays)
```
  - Bytes
```
public Bytes(java.io.InputStream in,
             int length)
      throws java.io.IOException
```
    Construct by reading certain number of bytes, or all of them, from a stream. Please note that if the stream contains less bytes than ordered, no exception will be thrown. This constructor will provide empty buffer on empty stream.
    
    Parameters:
    
    in - stream to read from
    
    length - how many bytes to read. If < 1, all file will be read.
    
    Throws:
    
    java.io.IOException
  - Bytes
```
public Bytes(java.io.ByteArrayOutputStream bos)
```
    Construct from ByteArrayOutputStream.toByteArray() bytes
    
    Parameters:
    
    bos -
  - Bytes
```
public Bytes(int size)
```
    Create zero-filled instance of the specified size
    
    Parameters:
    
    size - desired size
- Method Detail
  - fromHex
```
public static Bytes fromHex(java.lang.String hex)
```
    Construct from hexadecimal string. any spaces between digits are ignored.
    
    Parameters:
    
    hex - hexidecomal string, like "FF 01"
    
    Returns:
  - hexToByteArray
```
public static byte[] hexToByteArray(java.lang.String hex)
```
    Convert HEX string (ignoring whitespaces) to a byte[]
    
    Parameters:
    
    hex - strign
    
    Returns:
    
    decoded data
  - fromBase64
```
public static Bytes fromBase64(java.lang.String baseStr)
```
    Decode Base64 string into Bytes instance
    
    Parameters:
    
    baseStr - base64 string, possibily split to lines. Tries to add missing '=' to the end
    
    Returns:
  - fromString
```
public static Bytes fromString(java.lang.String str)
```
  - fromBigInt
```
public static Bytes fromBigInt(java.math.BigInteger value)
```
  - fromDouble
```
public static Bytes fromDouble(double value)
```
    Create buffer as standard IEEE double(8) representation, little-endian.
    
    Parameters:
    
    value -
    
    Returns:
  - size
```
public int size()
```
  - empty
```
public boolean empty()
```
    Check whether that the buffer is empty
    
    Returns:
    
    true if there is no one byte in the buffer
  - flipSelf
```
public Bytes flipSelf()
```
    Reverse order of own bytes. Chages own data and return self.
    
    Returns:
    
    self, after reversing all bytes.
  - toArray
```
public final byte[] toArray()
```
    return underlying bytes. This is cheap operation: no copying/conversion is performed.
    
    Returns:
    
    the wrapped bytes
  - dump
```
public void dump()
```
    Writes dump to standard output, in the same format as toDump(byte[])
  - dump
```
public static void dump(byte[] data)
```
    Writes dump into standrd output. Same as toDump(byte[]).
    
    Parameters:
    
    data - data to dump.
  - toDump
```
public static java.lang.String[] toDump(byte[] data)
```
    Generate dump string with address, hex bytes and ASCII character areas, line endings are "\n"s.
    
    Parameters:
    
    data - data to dump
    
    Returns:
  - toDump
```
public java.lang.String toDump()
```
  - toBigInteger
```
public java.math.BigInteger toBigInteger()
```
    Convert to a BigInteger value. Be sure to check desired bytes order and call flipSelf() first if necessary. See BigInteger.BigInteger(byte[]).
    
    Returns:
    
    resulting BigInteger instance
  - inspect
```
public java.lang.String inspect()
```
    Tries to convert bytes to UTF8 string. If the string seems to contain non-characters. convert it to base64 for readability. the type is shown by prefix, "t:" for utf8 text and "b64:" for base64
  - toBase64
```
public java.lang.String toBase64()
```
  - toHex
```
public java.lang.String toHex()
```
  - toHex
```
public java.lang.String toHex(boolean useSpaces)
```
  - toBase64Lines
```
public java.lang.String toBase64Lines()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - write
```
public void write(java.io.OutputStream out)
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - toDouble
```
public java.lang.Object toDouble()
```
  - sha1
```
public Bytes sha1()
```
  - sha256
```
public Bytes sha256(java.lang.Object... chunks)
```
    Calculate SHA256 hash for this instance optionally with any number of additional chinks. Hash is calculated on own bytes then on chunks if any.
    
    Parameters:
    
    chunks - chunks to concatenate to the calculated hash. Each chink should be either Bytes instance, String or byte[] array
    
    Returns:
    
    sha256 hashcode (32 bytes) in wrapped into the Bytes instance.
  - toInputStream
```
public java.io.ByteArrayInputStream toInputStream()
```
    Get an input stream to read contents of this buffer
    
    Returns:
    
    input stram
  - part
```
public Bytes part(int start)
```
    Extract part of the data from ith index (inclusive) to the end. Is a shortcat for part(i, 0); see part(int, int) for details. Note this method actually copy bytes!
    
    Parameters:
    
    start - index to copy. If < 0 means offstet from the end.
    
    Returns:
    
    Bytes instance with copied bytes.
  - part
```
public Bytes part(int start,
                  int length)
```
    Extract a part of bytes into new instance. Bytes are copied!. This utility function recalculates its params for convience:
    
    Negative start index means offser from the last element:
```
 part(-3, 3); // extracts last 3 bytes
 
```
    Length == 0 means all bytes since the start:
```
 part(10, 0); // all bytes starting with 10th
 part(-3, 0); // extracts last 3 bytes
 
```
    Length parameter is truncated if is bigger than remaining bytes length.
    Parameters:
    
    start - the start index, inclusive. If < 0 then means offset from the end of data
    
    length - the number of bytes to copy. When 0 then the all the rest of bytes will be copied. Is automatically truncated as need.
    
    Returns:
    
    the Bytes instance with copied part.
  - fillRandom
```
public Bytes fillRandom(int length)
```
    Return new block that is contcatenation of this block and length random bytes
    
    Parameters:
    
    length -
    
    Returns:
  - concatenate
```
public Bytes concatenate(Bytes other)
```
    Return new buffer that is a concatenation of this and other.
    
    Parameters:
    
    other - Bytes buffer to concatenate
    
    Returns:
    
    new Bytes instance
  - concatenate
```
public <T> Bytes concatenate(java.util.List<T> other)
```
  - concatenate
```
public Bytes concatenate(byte[] otherBytes)
```
    Return new buffer that is a concatenation of this and other.
    
    Parameters:
    
    otherBytes - Bytes buffer to concatenate
    
    Returns:
    
    new Bytes instance
  - random
```
public static Bytes random(int length)
```
    Create random bytes using SecureRandom RNG in SHA1PRNG mode.
    
    Parameters:
    
    length - length if bytes
    
    Returns:
  - padToSize
```
public Bytes padToSize(int size,
                       int fillByte)
```
    Return new Bytes instance padded to the required size. If the current size is less than or equal to the size, returns the copy of this.
    
    Parameters:
    
    size - desired size
    
    fillByte - fill byte
    
    Returns:
    
    new Bytes instance padded if necessary. Its size is always lesss or equal than size.
  - concatenate
```
public Bytes concatenate(java.lang.String s)
```
  - reverse
```
public Bytes reverse()
```
    Create a copy with this data in reverse order
    
    Returns:
    
    a new copy of Bytes in reverse order
  - correctIntFromGMP
```
public Bytes correctIntFromGMP()
```
  - toHex
```
public static java.lang.String toHex(byte[] data)
```
  - getData
```
public byte[] getData()
```

Class Bytes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bytes

Bytes

Bytes

Bytes

Bytes

Method Detail

fromHex

hexToByteArray

fromBase64

fromString

fromBigInt

fromDouble

size

empty

flipSelf

toArray

dump

dump

toDump

toDump

toBigInteger

inspect

toBase64

toHex

toHex

toBase64Lines

hashCode

equals

toString

write

toDouble

sha1

sha256

toInputStream

part

part

fillRandom

concatenate

concatenate

concatenate

random

padToSize

concatenate

reverse

correctIntFromGMP

toHex

getData