Returns a fixed-size list backed by the specified array, similar to Arrays#asList(Object[]). The list supports List#set(int, Object), but any attempt to set a value to null will result in a NullPointerException.

The returned list maintains the values, but not the identities, of Character objects written to or read from it. For example, whether list.get(0) == list.get(0) is true for the returned list is unspecified.

The returned list is serializable.

Parameters

backingArray:char[]

the array to back the list

Returns:List<Character>

a list view of the array

Returns the char value that is equal to value, if possible.

Parameters

value:long

any value in the range of the char type

Returns:char

the char value that equals value

Exceptions

IllegalArgumentException:

if value is greater than Character#MAX_VALUE or less than Character#MIN_VALUE

Compares the two specified char values. The sign of the value returned is the same as that of ((Character) a).compareTo(b).

Java 7+ users: this method should be treated as deprecated; use the equivalent Character#compare method instead.

Parameters

a:char

the first char to compare

b:char

the second char to compare

Returns:int

a negative value if a is less than b; a positive value if a is greater than b; or zero if they are equal

Returns the values from each provided array combined into a single array. For example, concat(new char[] {a, b}, new char[] {}, new char[] {c} returns the array {a, b, c}.

Parameters

arrays:char[][]

zero or more char arrays

Returns:char[]

a single array containing all the values from the source arrays, in order

Returns the value nearest to value which is within the closed range [min..max].

If value is within the range [min..max], value is returned unchanged. If value is less than min, min is returned, and if value is greater than max, max is returned.

Parameters

value:char

the char value to constrain

min:char

the lower bound (inclusive) of the range to constrain value to

max:char

the upper bound (inclusive) of the range to constrain value to

Exceptions

IllegalArgumentException:

if min > max

Since

21.0

Returns true if target is present as an element anywhere in array.

Parameters

array:char[]

an array of char values, possibly empty

target:char

a primitive char value

Returns:boolean

true if array[i] == target for some value of i

Returns an array containing the same values as array, but guaranteed to be of a specified minimum length. If array already has a length of at least minLength, it is returned directly. Otherwise, a new array of size minLength + padding is returned, containing the values of array, and zeroes in the remaining places.

Parameters

array:char[]

the source array

minLength:int

the minimum length the returned array must guarantee

padding:int

an extra amount to "grow" the array by if growth is necessary

Returns:char[]

an array containing the values of array, with guaranteed minimum length minLength

Exceptions

IllegalArgumentException:

if minLength or padding is negative

Returns the char value whose big-endian representation is stored in the first 2 bytes of bytes; equivalent to ByteBuffer.wrap(bytes).getChar(). For example, the input byte array {0x54, 0x32} would yield the char value '\\u5432'.

Arguably, it's preferable to use java.nio.ByteBuffer; that library exposes much more flexibility at little cost in readability.

Annotations

@GwtIncompatible

Exceptions

IllegalArgumentException:

if bytes has fewer than 2 elements

Returns the char value whose byte representation is the given 2 bytes, in big-endian order; equivalent to Chars.fromByteArray(new byte[] {b1, b2}).

Annotations

@GwtIncompatible

Since

7.0

Returns a hash code for value; equal to the result of invoking ((Character) value).hashCode().

Java 8+ users: use Character#hashCode(char) instead.

Parameters

value:char

a primitive char value

Returns:int

a hash code for the value

Returns the index of the first appearance of the value target in array.

Parameters

array:char[]

an array of char values, possibly empty

target:char

a primitive char value

Returns:int

the least index i for which array[i] == target, or -1 if no such index exists.

Returns the start position of the first occurrence of the specified target within array, or -1 if there is no such occurrence.

More formally, returns the lowest index i such that Arrays.copyOfRange(array, i, i + target.length) contains exactly the same elements as target.

Parameters

array:char[]

the array to search for the sequence target

target:char[]

the array to search for as a sub-sequence of array

Returns a string containing the supplied char values separated by separator. For example, join("-", '1', '2', '3') returns the string "1-2-3".

Parameters

separator:String

the text that should appear between consecutive values in the resulting string (but not at the start or end)

array:char[]

an array of char values, possibly empty

Returns the index of the last appearance of the value target in array.

Parameters

array:char[]

an array of char values, possibly empty

target:char

a primitive char value

Returns:int

the greatest index i for which array[i] == target, or -1 if no such index exists.

Returns a comparator that compares two char arrays lexicographically; not advisable for sorting user-visible strings as the ordering may not match the conventions of the user's locale. That is, it compares, using compare(char, char)), the first pair of values that follow any common prefix, or when one array is a prefix of the other, treats the shorter array as the lesser. For example, [] < ['a'] < ['a', 'b'] < ['b'].

The returned comparator is inconsistent with Object#equals(Object) (since arrays support only identity equality), but it is consistent with Arrays#equals(char[], char[]).

Since

2.0

Returns the greatest value present in array.

Parameters

array:char[]

a nonempty array of char values

Returns:char

the value present in array that is greater than or equal to every other value in the array

Exceptions

IllegalArgumentException:

if array is empty

Returns the least value present in array.

Parameters

array:char[]

a nonempty array of char values

Returns:char

the value present in array that is less than or equal to every other value in the array

Exceptions

IllegalArgumentException:

if array is empty

Reverses the elements of array. This is equivalent to Collections.reverse(Chars.asList(array)), but is likely to be more efficient.

Since

23.1

Reverses the elements of array between fromIndex inclusive and toIndex exclusive. This is equivalent to Collections.reverse(Chars.asList(array).subList(fromIndex, toIndex)), but is likely to be more efficient.

Exceptions

IndexOutOfBoundsException:

if fromIndex < 0, toIndex > array.length, or toIndex > fromIndex

Since

23.1

Performs a right rotation of array of "distance" places, so that the first element is moved to index "distance", and the element at index i ends up at index (distance + i) mod array.length. This is equivalent to Collections.rotate(Chars.asList(array), distance), but is considerably faster and avoids allocation and garbage collection.

The provided "distance" may be negative, which will rotate left.

Since

32.0.0

Performs a right rotation of array between fromIndex inclusive and toIndex exclusive. This is equivalent to Collections.rotate(Chars.asList(array).subList(fromIndex, toIndex), distance), but is considerably faster and avoids allocations and garbage collection.

The provided "distance" may be negative, which will rotate left.

Exceptions

IndexOutOfBoundsException:

if fromIndex < 0, toIndex > array.length, or toIndex > fromIndex

Since

32.0.0

Returns the char nearest in value to value.

Parameters

value:long

any long value

Returns:char

the same value cast to char if it is in the range of the char type, Character#MAX_VALUE if it is too large, or Character#MIN_VALUE if it is too small

Sorts the elements of array in descending order.

Since

23.1

Sorts the elements of array between fromIndex inclusive and toIndex exclusive in descending order.

Since

23.1

Copies a collection of Character instances into a new array of primitive char values.

Elements are copied from the argument collection as if by collection.toArray(). Calling this method is as thread-safe as calling that method.

Parameters

collection:Collection<Character>

a collection of Character objects

Returns:char[]

an array containing the same values as collection, in the same order, converted to primitives

Exceptions

NullPointerException:

if collection or any of its elements is null

Returns a big-endian representation of value in a 2-element byte array; equivalent to ByteBuffer.allocate(2).putChar(value).array(). For example, the input value '\\u5432' would yield the byte array {0x54, 0x32}.

If you need to convert and concatenate several values (possibly even of different types), use a shared java.nio.ByteBuffer instance, or use com.google.common.io.ByteStreams#newDataOutput() to get a growable buffer.

Annotations

@GwtIncompatible