at.favre.lib.bytes

Class MutableBytes

java.lang.Object

at.favre.lib.bytes.Bytes

at.favre.lib.bytes.MutableBytes

All Implemented Interfaces:

AbstractBytes, Comparable<Bytes>

public final class MutableBytes
extends Bytes

Mutable version of Bytes. 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()

Method Summary

Modifier and Type	Method and Description
MutableBytes	fill(byte fillByte) Fills the internal byte array with provided byte
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	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	wipe() Fills the internal byte array with all zeros

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

allocate, allocate, and, and, append, append, append, append, append, append, append, array, bigInteger, buffer, byteAt, byteOrder, byteOrder, compareTo, copy, copy, count, duplicate, encode, encodeBase36, encodeBase64, encodeBinary, encodeCharset, encodeDec, encodeHex, encodeHex, encodeOctal, encodeUtf8, entropy, equals, equalsContent, equalsContent, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, from, hashCode, indexOf, indexOf, inputStream, isEmpty, isReadOnly, lastIndexOf, leftShift, length, lengthBit, mutable, negate, or, or, parse, parseBase36, parseBase64, parseDec, parseHex, parseOctal, random, random, readOnly, resize, reverse, rightShift, shuffle, shuffle, sort, sort, switchBit, switchBit, toBitSet, toByte, toChar, toInt, toList, toLong, toObjectArray, toShort, toString, transform, validate, validateNotOnlyZeros, wrap, wrap, wrap, xor, xor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isMutable

public boolean isMutable()

Description copied from class: Bytes

Checks if instance is mutable

Specified by:

isMutable in interface AbstractBytes

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(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

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