MutableBytes (Bytes Utility Library 1.3.0 API)

java.lang.Object
- at.favre.lib.bytes.Bytes
- - at.favre.lib.bytes.MutableBytes

All Implemented Interfaces:

Serializable, AutoCloseable, Comparable<Bytes>, Iterable<Byte>
```
public final class MutableBytes
extends Bytes
implements AutoCloseable
```
Mutable version of Bytes created by calling Bytes.mutable(). If possible, all transformations are done in place, without creating a copy.
Adds additional mutator, which may change the internal array in-place, like wipe()

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MutableBytes`	`allocate(int length)` Creates a new instance with an empty array filled with zeros.
`static MutableBytes`	`allocate(int length, byte defaultValue)` Creates a new instance with an empty array filled with given defaultValue
`void`	`close()`
`boolean`	`equals(Object o)` Checks if this instance is equal to given other instance o
`MutableBytes`	`fill(byte fillByte)` Fills the internal byte array with provided byte
`int`	`hashCode()`
`Bytes`	`immutable()` Convert this instance to an immutable version with the same reference of the internal array and byte-order.
`boolean`	`isMutable()` Checks if instance is mutable
`MutableBytes`	`overwrite(byte[] newArray)` Uses given array to overwrite internal array
`MutableBytes`	`overwrite(byte[] newArray, int offsetInternalArray)` Uses given array to overwrite internal array.
`MutableBytes`	`overwrite(Bytes newBytes)` Uses given Bytes array to overwrite internal array
`MutableBytes`	`overwrite(Bytes newBytes, int offsetInternalArray)` Uses given Bytes array to overwrite internal array.
`MutableBytes`	`secureWipe()` Fills the internal byte array with random data provided by `SecureRandom`
`MutableBytes`	`secureWipe(SecureRandom random)` Fills the internal byte array with random data provided by given random instance
`MutableBytes`	`setByteAt(int index, byte newByte)` Sets new byte to given index
`MutableBytes`	`wipe()` Fills the internal byte array with all zeros

Methods inherited from class at.favre.lib.bytes.Bytes
and, and, append, append, append, append, append, append, append, append, append, append, appendNullSafe, array, bitAt, buffer, byteAt, byteOrder, byteOrder, charAt, compareTo, contains, copy, copy, count, count, duplicate, empty, encode, encodeBase32, encodeBase36, encodeBase64, encodeBase64, encodeBase64Url, encodeBinary, encodeCharset, encodeCharsetToBytes, encodeDec, encodeHex, encodeHex, encodeOctal, encodeRadix, encodeUtf8, encodeUtf8ToBytes, endsWith, entropy, equals, equals, equals, equalsConstantTime, equalsContent, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, fromNullSafe, hash, hashMd5, hashSha1, hashSha256, indexOf, indexOf, indexOf, indexOf, inputStream, intAt, isEmpty, isReadOnly, iterator, lastIndexOf, leftShift, length, lengthBit, longAt, mutable, not, or, or, parse, parseBase32, parseBase36, parseBase64, parseBinary, parseDec, parseHex, parseOctal, parseRadix, random, random, readOnly, resize, resize, reverse, rightShift, shortAt, startsWith, switchBit, switchBit, toBigInteger, toBitSet, toBoxedArray, toByte, toChar, toCharArray, toCharArray, toDouble, toDoubleArray, toFloat, toFloatArray, toInt, toIntArray, toList, toLong, toLongArray, toShort, toString, toUnsignedByte, toUUID, transform, unsecureRandom, unsecureRandom, unsignedByteAt, validate, validateNotOnlyZeros, wrap, wrap, wrap, wrapNullSafe, xor, xor

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - allocate
```
public static MutableBytes allocate(int length)
```
    Creates a new instance with an empty array filled with zeros.
    
    Parameters:
    
    length - of the internal array
    
    Returns:
    
    new instance
  - allocate
```
public static MutableBytes allocate(int length,
                                    byte defaultValue)
```
    Creates a new instance with an empty array filled with given defaultValue
    
    Parameters:
    
    length - of the internal array
    
    defaultValue - to fill with
    
    Returns:
    
    new instance
  - isMutable
```
public boolean isMutable()
```
    Description copied from class: Bytes
    
    Checks if instance is mutable
    
    Overrides:
    
    isMutable in class Bytes
    
    Returns:
    
    true if mutable, ie. transformers will change internal array
  - overwrite
```
public MutableBytes overwrite(byte[] newArray)
```
    Uses given array to overwrite internal array
    
    Parameters:
    
    newArray - used to overwrite internal
    
    Returns:
    
    this instance
    
    Throws:
    
    IndexOutOfBoundsException - if newArray.length > internal length
  - overwrite
```
public MutableBytes overwrite(Bytes newBytes)
```
    Uses given Bytes array to overwrite internal array
    
    Parameters:
    
    newBytes - used to overwrite internal
    
    Returns:
    
    this instance
    
    Throws:
    
    IndexOutOfBoundsException - if newArray.length > internal length
  - overwrite
```
public MutableBytes overwrite(byte[] newArray,
                              int offsetInternalArray)
```
    Uses given array to overwrite internal array.
    
    Parameters:
    
    newArray - used to overwrite internal
    
    offsetInternalArray - index of the internal array to start overwriting
    
    Returns:
    
    this instance
    
    Throws:
    
    IndexOutOfBoundsException - if newArray.length + offsetInternalArray > internal length
  - overwrite
```
public MutableBytes overwrite(Bytes newBytes,
                              int offsetInternalArray)
```
    Uses given Bytes array to overwrite internal array.
    
    Parameters:
    
    newBytes - used to overwrite internal
    
    offsetInternalArray - index of the internal array to start overwriting
    
    Returns:
    
    this instance
    
    Throws:
    
    IndexOutOfBoundsException - if newBytes.length + offsetInternalArray > internal length
  - setByteAt
```
public MutableBytes setByteAt(int index,
                              byte newByte)
```
    Sets new byte to given index
    
    Parameters:
    
    index - the index to change
    
    newByte - the new byte to set
    
    Returns:
    
    this instance
  - wipe
```
public MutableBytes wipe()
```
    Fills the internal byte array with all zeros
    
    Returns:
    
    this instance
  - fill
```
public MutableBytes fill(byte fillByte)
```
    Fills the internal byte array with provided byte
    
    Parameters:
    
    fillByte - to fill with
    
    Returns:
    
    this instance
  - secureWipe
```
public MutableBytes secureWipe()
```
    Fills the internal byte array with random data provided by SecureRandom
    
    Returns:
    
    this instance
  - secureWipe
```
public MutableBytes secureWipe(SecureRandom random)
```
    Fills the internal byte array with random data provided by given random instance
    
    Parameters:
    
    random - to generate entropy
    
    Returns:
    
    this instance
  - immutable
```
public Bytes immutable()
```
    Convert this instance to an immutable version with the same reference of the internal array and byte-order. If the mutable instance is kept, it can be used to alter the internal array of the just created instance, so be aware.
    
    Returns:
    
    immutable version of this instance
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Bytes
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: Bytes
    
    Checks if this instance is equal to given other instance o
    
    Overrides:
    
    equals in class Bytes
    
    Parameters:
    
    o - other instance
    
    Returns:
    
    if the instance are equal
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class MutableBytes

Method Summary

Methods inherited from class at.favre.lib.bytes.Bytes

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

allocate

allocate

isMutable

overwrite

overwrite

overwrite

overwrite

setByteAt

wipe

fill

secureWipe

secureWipe

immutable

hashCode

equals

close