Return type | Name and parameters |
---|---|
boolean
|
any(Closure predicate)
Iterates over the contents of a byte Array, and checks whether a predicate is valid for at least one element. |
boolean
|
asBoolean()
Coerces a byte array to a boolean value. |
BigDecimal
|
average()
Calculates the average of the bytes in the array. |
List
|
chop(int chopSizes)
Chops the byte array into pieces, returning lists with sizes corresponding to the supplied chop sizes. |
boolean
|
contains(Object value)
Checks whether the array contains the given value. |
Number
|
count(Object value)
Counts the number of occurrences of the given value inside this array. |
String
|
digest(String algorithm)
digest the byte array |
byte[]
|
each(Consumer consumer)
Iterates through a byte[] passing each byte to the given consumer. |
void
|
eachByte(Closure closure)
Traverses through each byte of this byte array. |
byte[]
|
eachWithIndex(Closure closure)
Iterates through a byte[], passing each byte and the element's index (a counter starting at zero) to the given closure. |
Writable
|
encodeBase64()
Produce a Writable object which writes the Base64 encoding of the byte array. |
Writable
|
encodeBase64(boolean chunked)
Produce a Writable object which writes the Base64 encoding of the byte array. |
Writable
|
encodeBase64Url()
Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array. |
Writable
|
encodeBase64Url(boolean pad)
Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array. |
Writable
|
encodeHex()
Produces a Writable that writes the hex encoding of the byte[]. |
boolean
|
equals(byte[] right)
Compares the contents of this array to the contents of the given array. |
boolean
|
every(Closure predicate)
Iterates over the contents of a byte Array, and checks whether a predicate is valid for all elements. |
byte
|
first()
Returns the first item from the byte array. |
List
|
flatten()
Flattens an array. |
List
|
getAt(IntRange range)
Supports the subscript operator for a byte array with an IntRange giving the desired indices. |
List
|
getAt(ObjectRange range)
Supports the subscript operator for a byte array with an ObjectRange giving the desired indices. |
List
|
getAt(Range range)
Supports the subscript operator for a byte array with a range giving the desired indices. |
List
|
getAt(Collection indices)
Supports the subscript operator for a byte array with a (potentially nested) collection giving the desired indices. |
IntRange
|
getIndices()
Returns indices of the byte array. |
byte
|
head()
Returns the first item from the byte array. |
byte[]
|
init()
Returns the items from the byte array excluding the last item. |
String
|
join()
Concatenates the string representation of each item in this array. |
String
|
join(String separator)
Concatenates the string representation of each item in this array, with the given String as a separator between each item. |
byte
|
last()
Returns the last item from the byte array. |
String
|
md5()
Calculate md5 of the byte array |
void
|
putAt(IntRange range, byte[] source)
A helper method to allow arrays to be set with subscript operators. |
void
|
putAt(IntRange range, Iterable source)
A helper method to allow arrays to be set with subscript operators. |
byte[]
|
reverse()
Creates a new byte array containing items which are the same as this array but in reverse order. |
byte[]
|
reverse(boolean mutate)
Reverses the items in an array. |
byte[]
|
reverseEach(Closure closure)
Iterates through a byte[] in reverse order passing each byte to the given closure. |
String
|
sha256()
Calculate SHA-256 of the byte array |
int
|
size()
Provides arrays with a size method similar to collections.
|
Stream
|
stream()
Returns a sequential Stream with the specified array as its source. |
byte
|
sum()
Sums the items in an array. |
byte
|
sum(byte initialValue)
Sums the items in an array, adding the result to some initial value. |
byte[]
|
swap(int i, int j)
Swaps two elements at the specified positions. |
byte[]
|
tail()
Returns the items from the byte array excluding the first item. |
List
|
toList()
Converts this array to a List of the same size, with each element added to the list. |
Set
|
toSet()
Converts this array to a Set, with each unique element added to the set. |
String
|
toString()
Returns the string representation of the given array. |
Iterates over the contents of a byte Array, and checks whether a predicate is valid for at least one element.
byte[] array = [0, 1, 2] assert array.any{ it > 1 } assert !array.any{ it > 3 }
predicate
- the closure predicate used for matchingCoerces a byte array to a boolean value. A byte array is false if the array is null or of length 0, and true otherwise.
byte[] array1 = [] assert !array1 byte[] array2 = [0] assert array2
Calculates the average of the bytes in the array.
assert 5.0G == ([2,4,6,8] as byte[]).average()
Chops the byte array into pieces, returning lists with sizes corresponding to the supplied chop sizes. If the array isn't large enough, truncated (possibly empty) pieces are returned. Using a chop size of -1 will cause that piece to contain all remaining items from the array.
byte[] array = [0, 1, 2] assert array.chop(1, 2) == [[0], [1, 2]]
chopSizes
- the sizes for the returned piecesChecks whether the array contains the given value.
value
- the value being searched forCounts the number of occurrences of the given value inside this array.
Comparison is done using Groovy's == operator (using
compareTo(value) == 0
).
byte[] array = [10, 20, 20, 30] assert array.count(20) == 2
value
- the value being searched fordigest the byte array
Iterates through a byte[] passing each byte to the given consumer.
byte[] array = [0, 1, 2] String result = '' array.each{ result += it } assert result == '012'
consumer
- the consumer for each byteTraverses through each byte of this byte array.
closure
- a closureIterates through a byte[], passing each byte and the element's index (a counter starting at zero) to the given closure.
byte[] array = [10, 20, 30]
String result = ''
array.eachWithIndex{ item, index ->
result += "$index($item)" }
assert result == '0(10)1(20)2(30)'
closure
- a Closure to operate on each byteProduce a Writable object which writes the Base64 encoding of the byte array.
Calling toString() on the result returns the encoding as a String. For more
information on Base64 encoding and chunking see RFC 4648
.
Produce a Writable object which writes the Base64 encoding of the byte array.
Calling toString() on the result returns the encoding as a String. For more
information on Base64 encoding and chunking see RFC 4648
.
chunked
- whether the Base64 encoded data should be MIME chunkedProduce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array.
Calling toString() on the result returns the encoding as a String. For more
information on Base64 URL and Filename Safe encoding see RFC 4648 - Section 5
Base 64 Encoding with URL and Filename Safe Alphabet
.
The method omits padding and is equivalent to calling
EncodingGroovyMethods#encodeBase64Url(byte[], boolean) with a
value of false
.
Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array.
Calling toString() on the result returns the encoding as a String. For more
information on Base64 URL and Filename Safe encoding see RFC 4648 - Section 5
Base 64 Encoding with URL and Filename Safe Alphabet
.
pad
- whether the encoded data should be paddedProduces a Writable that writes the hex encoding of the byte[]. Calling toString() on this Writable returns the hex encoding as a String. The hex encoding includes two characters for each byte and all letters are lower case.
Compares the contents of this array to the contents of the given array.
Example usage:
byte[] array1 = [4, 8] byte[] array2 = [4, 8] assert array1 !== array2 assert array1.equals(array2)
right
- the array being comparedIterates over the contents of a byte Array, and checks whether a predicate is valid for all elements.
byte[] array = [0, 1, 2] assert array.every{ it < 3 } assert !array.every{ it > 1 }
predicate
- the closure predicate used for matchingReturns the first item from the byte array.
byte[] bytes = [1, 2, 3] assert bytes.first() == 1An alias for
head()
.
Flattens an array. This array is added to a new collection.
It is an alias for toList()
but allows algorithms to be written which also
work on multidimensional arrays or non-arrays where flattening would be applicable.
byte[] array = [0, 1] assert array.flatten() == [0, 1]
Supports the subscript operator for a byte array with an IntRange giving the desired indices.
byte[] array = [0, 10, 20, 30, 40] assert array[2..3] == [20, 30] assert array[-2..-1] == [30, 40] assert array[-1..-2] == [40, 30]
range
- an IntRange indicating the indices for the items to retrieveSupports the subscript operator for a byte array with an ObjectRange giving the desired indices.
byte[] array = [0, 10, 20, 30, 40] def range = new ObjectRange(2, 3) assert array[range] == [20, 30]
range
- an ObjectRange indicating the indices for the items to retrieveSupports the subscript operator for a byte array with a range giving the desired indices.
byte[] array = [1, 3, 5, 7, 9, 11] assert array[2..<2] == [] // EmptyRange assert array[(0..5.5).step(2)] == [1, 5, 9] // NumberRange assert array[(1..5.5).step(2)] == [3, 7, 11] // NumberRange
range
- a range indicating the indices for the items to retrieveSupports the subscript operator for a byte array with a (potentially nested) collection giving the desired indices.
byte[] array = [0, 2, 4, 6, 8] assert array[2, 3] == [4, 6] assert array[1, 0..1, [0, [-1]]] == [2, 0, 2, 0, 8]
indices
- a collection of indices for the items to retrieveReturns indices of the byte array.
byte[] array = [0, 1] assert array.indices == 0..1
Returns the first item from the byte array.
byte[] bytes = [1, 2, 3] assert bytes.head() == 1An alias for
first()
.
Returns the items from the byte array excluding the last item.
byte[] bytes = [1, 2, 3] def result = bytes.init() assert result == [1, 2] assert bytes.class.componentType == result.class.componentType
Concatenates the string representation of each item in this array.
Concatenates the string representation of each item in this array, with the given String as a separator between each item.
separator
- a String separatorReturns the last item from the byte array.
byte[] bytes = [1, 2, 3] assert bytes.last() == 3
Calculate md5 of the byte array
A helper method to allow arrays to be set with subscript operators.
byte[] from = [1, 1, 1] byte[] to = [0, 0, 0, 0, 0] to[1..3] = from assert to == [0, 1, 1, 1, 0]
range
- the subset of the array to setsource
- the source array from which new values will comeA helper method to allow arrays to be set with subscript operators. Zero will be used if the source iterable has insufficient elements.
def from = [1, 1, 1] byte[] to = [0, 0, 0, 0, 0] to[1..3] = from assert to == [0, 1, 1, 1, 0]
range
- the subset of the array to setsource
- the source array from which new values will comeCreates a new byte array containing items which are the same as this array but in reverse order.
byte[] array = 1..2 assert array.reverse() == 2..1
Reverses the items in an array. If mutate is true, the original array is modified in place and returned. Otherwise, a new array containing the reversed items is produced.
byte[] array = 1..3 def yarra = array.reverse(true) assert array == 3..1 assert yarra == 3..1 assert array === yarra yarra = array.reverse(false) assert array !== yarra assert array == 3..1 assert yarra == 1..3
mutate
- true
if the array itself should be reversed in place, false
if a new array should be createdIterates through a byte[] in reverse order passing each byte to the given closure.
byte[] array = [0, 1, 2] String result = '' array.reverseEach{ result += it } assert result == '210'
closure
- the closure applied on each byteCalculate SHA-256 of the byte array
Provides arrays with a size
method similar to collections.
Returns a sequential Stream with the specified array as its source.
Stream
for the arraySums the items in an array.
assert (1+2+3+4 as byte) == ([1,2,3,4] as byte[]).sum()
Sums the items in an array, adding the result to some initial value.
assert (5+1+2+3+4 as byte) == ([1,2,3,4] as byte[]).sum(5 as byte)
initialValue
- the items in the array will be summed to this initial valueSwaps two elements at the specified positions.
Example:
assert ([1, 3, 2, 4] as byte[]) == ([1, 2, 3, 4] as byte[]).swap(1, 2)
i
- a positionj
- a positionReturns the items from the byte array excluding the first item.
byte[] bytes = [1, 2, 3] def result = bytes.tail() assert result == [2, 3] assert bytes.class.componentType == result.class.componentType
Converts this array to a List of the same size, with each element added to the list.
Converts this array to a Set, with each unique element added to the set.
byte[] array = [1, 2, 3, 2, 1] Set expected = [1, 2, 3] assert array.toSet() == expected
Returns the string representation of the given array.
byte[] array = [1, 2, 3, 2, 1] assert array.toString() == '[1, 2, 3, 2, 1]'