Class Shorts
- java.lang.Object
-
- com.google.common.primitives.Shorts
-
@GwtCompatible(emulated=true) public final class Shorts extends java.lang.Object
Static utility methods pertaining toshortprimitives, that are not already found in eitherShortorArrays.See the Guava User Guide article on primitive utilities.
- Since:
- 1.0
-
-
Field Summary
Fields Modifier and Type Field Description static intBYTESThe number of bytes required to represent a primitiveshortvalue.static shortMAX_POWER_OF_TWOThe largest power of two that can be represented as ashort.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.util.List<java.lang.Short>asList(short... backingArray)Returns a fixed-size list backed by the specified array, similar toArrays.asList(Object[]).static shortcheckedCast(long value)Returns theshortvalue that is equal tovalue, if possible.static intcompare(short a, short b)Compares the two specifiedshortvalues.static short[]concat(short[]... arrays)Returns the values from each provided array combined into a single array.static booleancontains(short[] array, short target)Returnstrueiftargetis present as an element anywhere inarray.static short[]ensureCapacity(short[] array, int minLength, int padding)Returns an array containing the same values asarray, but guaranteed to be of a specified minimum length.static shortfromByteArray(byte[] bytes)Returns theshortvalue whose big-endian representation is stored in the first 2 bytes ofbytes; equivalent toByteBuffer.wrap(bytes).getShort().static shortfromBytes(byte b1, byte b2)Returns theshortvalue whose byte representation is the given 2 bytes, in big-endian order; equivalent toShorts.fromByteArray(new byte[] {b1, b2}).static inthashCode(short value)Returns a hash code forvalue; equal to the result of invoking((Short) value).hashCode().static intindexOf(short[] array, short target)Returns the index of the first appearance of the valuetargetinarray.static intindexOf(short[] array, short[] target)Returns the start position of the first occurrence of the specifiedtargetwithinarray, or-1if there is no such occurrence.static java.lang.Stringjoin(java.lang.String separator, short... array)Returns a string containing the suppliedshortvalues separated byseparator.static intlastIndexOf(short[] array, short target)Returns the index of the last appearance of the valuetargetinarray.static java.util.Comparator<short[]>lexicographicalComparator()Returns a comparator that compares twoshortarrays lexicographically.static shortmax(short... array)Returns the greatest value present inarray.static shortmin(short... array)Returns the least value present inarray.static shortsaturatedCast(long value)Returns theshortnearest in value tovalue.static Converter<java.lang.String,java.lang.Short>stringConverter()Returns a serializable converter object that converts between strings and shorts usingShort.decode(java.lang.String)andShort.toString().static short[]toArray(java.util.Collection<? extends java.lang.Number> collection)Returns an array containing each value ofcollection, converted to ashortvalue in the manner ofNumber.shortValue().static byte[]toByteArray(short value)Returns a big-endian representation ofvaluein a 2-element byte array; equivalent toByteBuffer.allocate(2).putShort(value).array().
-
-
-
Field Detail
-
BYTES
public static final int BYTES
The number of bytes required to represent a primitiveshortvalue.- See Also:
- Constant Field Values
-
MAX_POWER_OF_TWO
public static final short MAX_POWER_OF_TWO
The largest power of two that can be represented as ashort.- Since:
- 10.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
hashCode
public static int hashCode(short value)
Returns a hash code forvalue; equal to the result of invoking((Short) value).hashCode().- Parameters:
value- a primitiveshortvalue- Returns:
- a hash code for the value
-
checkedCast
public static short checkedCast(long value)
Returns theshortvalue that is equal tovalue, if possible.- Parameters:
value- any value in the range of theshorttype- Returns:
- the
shortvalue that equalsvalue - Throws:
java.lang.IllegalArgumentException- ifvalueis greater thanShort.MAX_VALUEor less thanShort.MIN_VALUE
-
saturatedCast
public static short saturatedCast(long value)
Returns theshortnearest in value tovalue.- Parameters:
value- anylongvalue- Returns:
- the same value cast to
shortif it is in the range of theshorttype,Short.MAX_VALUEif it is too large, orShort.MIN_VALUEif it is too small
-
compare
public static int compare(short a, short b)Compares the two specifiedshortvalues. The sign of the value returned is the same as that of((Short) a).compareTo(b).Note: projects using JDK 7 or later should use the equivalent
Short.compare(short, short)method instead.- Parameters:
a- the firstshortto compareb- the secondshortto compare- Returns:
- a negative value if
ais less thanb; a positive value ifais greater thanb; or zero if they are equal
-
contains
public static boolean contains(short[] array, short target)Returnstrueiftargetis present as an element anywhere inarray.- Parameters:
array- an array ofshortvalues, possibly emptytarget- a primitiveshortvalue- Returns:
trueifarray[i] == targetfor some value ofi
-
indexOf
public static int indexOf(short[] array, short target)Returns the index of the first appearance of the valuetargetinarray.- Parameters:
array- an array ofshortvalues, possibly emptytarget- a primitiveshortvalue- Returns:
- the least index
ifor whicharray[i] == target, or-1if no such index exists.
-
indexOf
public static int indexOf(short[] array, short[] target)Returns the start position of the first occurrence of the specifiedtargetwithinarray, or-1if there is no such occurrence.More formally, returns the lowest index
isuch thatjava.util.Arrays.copyOfRange(array, i, i + target.length)contains exactly the same elements astarget.- Parameters:
array- the array to search for the sequencetargettarget- the array to search for as a sub-sequence ofarray
-
lastIndexOf
public static int lastIndexOf(short[] array, short target)Returns the index of the last appearance of the valuetargetinarray.- Parameters:
array- an array ofshortvalues, possibly emptytarget- a primitiveshortvalue- Returns:
- the greatest index
ifor whicharray[i] == target, or-1if no such index exists.
-
min
public static short min(short... array)
Returns the least value present inarray.- Parameters:
array- a nonempty array ofshortvalues- Returns:
- the value present in
arraythat is less than or equal to every other value in the array - Throws:
java.lang.IllegalArgumentException- ifarrayis empty
-
max
public static short max(short... array)
Returns the greatest value present inarray.- Parameters:
array- a nonempty array ofshortvalues- Returns:
- the value present in
arraythat is greater than or equal to every other value in the array - Throws:
java.lang.IllegalArgumentException- ifarrayis empty
-
concat
public static short[] concat(short[]... arrays)
Returns the values from each provided array combined into a single array. For example,concat(new short[] {a, b}, new short[] {}, new short[] {c}returns the array{a, b, c}.- Parameters:
arrays- zero or moreshortarrays- Returns:
- a single array containing all the values from the source arrays, in order
-
toByteArray
@GwtIncompatible("doesn\'t work") public static byte[] toByteArray(short value)
Returns a big-endian representation ofvaluein a 2-element byte array; equivalent toByteBuffer.allocate(2).putShort(value).array(). For example, the input value(short) 0x1234would yield the byte array{0x12, 0x34}.If you need to convert and concatenate several values (possibly even of different types), use a shared
ByteBufferinstance, or useByteStreams.newDataOutput()to get a growable buffer.
-
fromByteArray
@GwtIncompatible("doesn\'t work") public static short fromByteArray(byte[] bytes)
Returns theshortvalue whose big-endian representation is stored in the first 2 bytes ofbytes; equivalent toByteBuffer.wrap(bytes).getShort(). For example, the input byte array{0x54, 0x32}would yield theshortvalue0x5432.Arguably, it's preferable to use
ByteBuffer; that library exposes much more flexibility at little cost in readability.- Throws:
java.lang.IllegalArgumentException- ifbyteshas fewer than 2 elements
-
fromBytes
@GwtIncompatible("doesn\'t work") public static short fromBytes(byte b1, byte b2)
Returns theshortvalue whose byte representation is the given 2 bytes, in big-endian order; equivalent toShorts.fromByteArray(new byte[] {b1, b2}).- Since:
- 7.0
-
stringConverter
@Beta public static Converter<java.lang.String,java.lang.Short> stringConverter()
Returns a serializable converter object that converts between strings and shorts usingShort.decode(java.lang.String)andShort.toString().- Since:
- 16.0
-
ensureCapacity
public static short[] ensureCapacity(short[] array, int minLength, int padding)Returns an array containing the same values asarray, but guaranteed to be of a specified minimum length. Ifarrayalready has a length of at leastminLength, it is returned directly. Otherwise, a new array of sizeminLength + paddingis returned, containing the values ofarray, and zeroes in the remaining places.- Parameters:
array- the source arrayminLength- the minimum length the returned array must guaranteepadding- an extra amount to "grow" the array by if growth is necessary- Returns:
- an array containing the values of
array, with guaranteed minimum lengthminLength - Throws:
java.lang.IllegalArgumentException- ifminLengthorpaddingis negative
-
join
public static java.lang.String join(java.lang.String separator, short... array)Returns a string containing the suppliedshortvalues separated byseparator. For example,join("-", (short) 1, (short) 2, (short) 3)returns the string"1-2-3".- Parameters:
separator- the text that should appear between consecutive values in the resulting string (but not at the start or end)array- an array ofshortvalues, possibly empty
-
lexicographicalComparator
public static java.util.Comparator<short[]> lexicographicalComparator()
Returns a comparator that compares twoshortarrays lexicographically. That is, it compares, usingcompare(short, short)), 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,[] < [(short) 1] < [(short) 1, (short) 2] < [(short) 2].The returned comparator is inconsistent with
Object.equals(Object)(since arrays support only identity equality), but it is consistent withArrays.equals(short[], short[]).- Since:
- 2.0
- See Also:
- Lexicographical order article at Wikipedia
-
toArray
public static short[] toArray(java.util.Collection<? extends java.lang.Number> collection)
Returns an array containing each value ofcollection, converted to ashortvalue in the manner ofNumber.shortValue().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- a collection ofNumberinstances- Returns:
- an array containing the same values as
collection, in the same order, converted to primitives - Throws:
java.lang.NullPointerException- ifcollectionor any of its elements is null- Since:
- 1.0 (parameter was
Collection<Short>before 12.0)
-
asList
public static java.util.List<java.lang.Short> asList(short... backingArray)
Returns a fixed-size list backed by the specified array, similar toArrays.asList(Object[]). The list supportsList.set(int, Object), but any attempt to set a value tonullwill result in aNullPointerException.The returned list maintains the values, but not the identities, of
Shortobjects written to or read from it. For example, whetherlist.get(0) == list.get(0)is true for the returned list is unspecified.- Parameters:
backingArray- the array to back the list- Returns:
- a list view of the array
-
-