Package org.apache.juneau.commons.utils

Class Shorts

java.lang.Object

org.apache.juneau.commons.utils.Shorts

Direct Known Subclasses:

BasicTestUtils

public class Shorts
extends Object

Terse alias facade for the domain utility classes.

A single wildcard static import (import static org.apache.juneau.commons.utils.Shorts.*;) exposes the entire short-name vocabulary. Almost every method here is a one-line delegation to a canonical, fully-descriptive method on a domain class — behavior is identical to calling the canonical method directly — and each such alias documents its target via an @see tag. Canonical implementations live in ObjectUtils, StringUtils, CollectionUtils, ClassUtils, ThrowableUtils, IoUtils, FileUtils, PredicateUtils, SystemUtils, DateUtils, and ReflectionUtils.

Documented exception: the terse exception factories (rex/brex/ iaex/isex/uoex/uoroex/ioex/exex) are self-contained — they construct the exception directly rather than delegating to a domain class — so that the domain *Utils classes can stay Shorts-free (they use the package-private Exceptions helper instead). These are the only methods in this class with no @see tag, apart from the argument/state checks described next.

Argument and state checks: the req* family (req, reqnn, reqnb, reqnns, reqt, reqcat; throwing IllegalArgumentException) and the chk* family (chk, chknn; throwing IllegalStateException) are also self-contained: Shorts holds their canonical implementations. Because of that, the domain *Utils classes may import Shorts for req*/chk* calls. That is the only relaxation: a domain class may use the self-contained members of Shorts (exception factories, req*, chk*) but never a delegating alias, because that alias would call back into a domain class.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder timeout(String name, Duration value) { name = reqnb("name", name); timeout = reqnn("value", value); req(! value.isNegative(), "Argument 'value' cannot be negative: %s", value); chk(! built, "Builder already used."); return this; }

Disjointness invariant: no Shorts alias name is identical to the canonical (full) method name of any method in any domain class. This lets a developer wildcard-import Shorts.* alongside any single domain *Utils.* with zero method-name collisions.

This class is the replacement for the former Utils grab-bag (now deleted): callers replace import static ...utils.Utils.* with import static ...utils.Shorts.*.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Shorts()	Constructor — this class is meant to be subclassed.

Method Summary

Modifier and Type	Method	Description
static <T> T[]	a(T... x)	Creates an array from the specified elements.
static <E> E[][]	a2(E[]... v)	Creates a 2-dimensional array from the specified rows.
static <E> List<E>	aa(List<E> v, E... e)	Adds the specified elements to the given list and returns it.
static boolean	and(boolean... v)	Returns true if all of the specified booleans are true.
static boolean	any(boolean... v)	Returns true if any of the specified booleans are true.
static Object[]	ao(Object... v)	Creates an Object[] from the specified elements.
static <E> E	at(List<E> l, int i)	Returns the element at the specified index of a list (null-safe).
static boolean	b(Object v)	Converts the specified object to a boolean.
static String	bin(String s)	Returns a blank (single-space) string if the specified string is null, else the string.
static boolean[]	booleans(boolean... v)	Creates a boolean[] from the specified values.
static BeanRuntimeException	brex(Class<?> c, String m, Object... a)	Creates a BeanRuntimeException with an associated class and formatted message.
static BeanRuntimeException	brex(String m, Object... a)	Creates a BeanRuntimeException with a formatted message.
static BeanRuntimeException	brex(Throwable t)	Creates a BeanRuntimeException wrapping a cause.
static BeanRuntimeException	brex(Throwable t, Class<?> c, String m, Object... a)	Creates a BeanRuntimeException with a cause, associated class, and formatted message.
static BeanRuntimeException	brex(Throwable t, String m, Object... a)	Creates a BeanRuntimeException with a cause and formatted message.
static BeanRuntimeException	brex(Throwable t, ClassInfo c, String m, Object... a)	Creates a BeanRuntimeException with a cause, associated class, and formatted message.
static BeanRuntimeException	brex(ClassInfo c, String m, Object... a)	Creates a BeanRuntimeException with an associated class and formatted message.
static boolean	btw(int n, int lo, int hi)	Returns true if the specified integer is within the inclusive range.
static byte[]	bytes(int... v)	Creates a byte[] from the specified int values.
static <T> T	cast(Class<T> c, Object o)	Casts the specified object to the specified type (null-safe).
static <T> T	cex(Class<T> c, Throwable t)	Casts the specified throwable to the specified type, wrapping if necessary.
static char[]	chars(char... v)	Creates a char[] from the specified values.
static void	chk(boolean expression, String msg, Object... args)	Throws an IllegalStateException if the specified expression is false.
static <T> T	chknn(T o, String msg, Object... args)	Throws an IllegalStateException if the specified object is null.
static int	cmp(Object a, Object b)	Compares two objects for order (null-safe).
static String	cn(Object o)	Returns the fully-qualified class name of the specified object (null-safe).
static String	cns(Object o)	Returns the simple class name of the specified object (null-safe).
static String	cnsq(Object o)	Returns the qualified simple class name of the specified object (includes enclosing classes).
static boolean	co(String s, String x)	Returns true if the string contains the specified substring (null-safe).
static boolean[]	cp(boolean[] v)	Makes a copy of the specified array.
static byte[]	cp(byte[] v)	Makes a copy of the specified array.
static char[]	cp(char[] v)	Makes a copy of the specified array.
static double[]	cp(double[] v)	Makes a copy of the specified array.
static float[]	cp(float[] v)	Makes a copy of the specified array.
static int[]	cp(int[] v)	Makes a copy of the specified array.
static long[]	cp(long[] v)	Makes a copy of the specified array.
static short[]	cp(short[] v)	Makes a copy of the specified array.
static <E> Collection<E>	cp(Collection<E> v)	Creates a new collection from the specified collection.
static <E> List<E>	cp(List<E> v)	Returns a mutable copy of the specified list.
static <E> List<E>	cp(List<E> v, Function<? super E,? extends E> valueMapper)	Makes a deep copy of the specified list, transforming each value.
static <E> List<E>	cp(List<E> v, Function<? super E,? extends E> valueMapper, Supplier<List<E>> listFactory)	Makes a deep copy of the specified list, transforming each value using the specified list factory.
static <K, V> Map<K,V>	cp(Map<K,V> v)	Creates a new map from the specified map.
static <K, V> Map<K,V>	cp(Map<K,V> v, Function<? super V,? extends V> valueMapper)	Makes a deep copy of the specified map, transforming each value.
static <K, V> Map<K,V>	cp(Map<K,V> v, Function<? super V,? extends V> valueMapper, Supplier<Map<K,V>> mapFactory)	Makes a deep copy of the specified map, transforming each value using the specified map factory.
static <E> Set<E>	cp(Set<E> v)	Creates a new set from the specified set.
static <E> Set<E>	cp(Set<E> v, Function<? super E,? extends E> valueMapper)	Makes a deep copy of the specified set, transforming each value.
static <E> Set<E>	cp(Set<E> v, Function<? super E,? extends E> valueMapper, Supplier<Set<E>> setFactory)	Makes a deep copy of the specified set, transforming each value using the specified set factory.
static <T> T[]	cp(T[] v)	Makes a copy of the specified array.
static double[]	doubles(double... v)	Creates a double[] from the specified values.
static String	ein(Object o)	Returns an empty string if the specified object is null, else its string form.
static String	ein(String s)	Returns an empty string if the specified string is null, else the string.
static boolean	eq(boolean ci, String a, String b)	Returns true if the two strings are equal, optionally ignoring case.
static <T> boolean	eq(T a, T b)	Returns true if the two objects are equal (null-safe).
static <T, U> boolean	eq(T a, U b, BiPredicate<T,U> t)	Returns true if the two objects are equal using the specified equality test.
static <T> boolean	eqa(T a, T... b)	Returns true if the first object equals any of the remaining objects.
static boolean	eqic(Object a, Object b)	Returns true if the two objects are equal ignoring case (via their string forms).
static boolean	eqic(String a, String b)	Returns true if the two strings are equal ignoring case (null-safe).
static boolean	ew(String s, String x)	Returns true if the string ends with the specified suffix (null-safe).
static ExecutableException	exex(String m, Object... a)	Creates an ExecutableException with a formatted message.
static ExecutableException	exex(Throwable t)	Creates an ExecutableException wrapping a cause.
static ExecutableException	exex(Throwable t, String m, Object... a)	Creates an ExecutableException with a cause and formatted message.
static String	f(String p, Object... a)	Formats a message using printf-style (%s/%d/…) placeholders.
static <T extends Throwable> Optional<T>	fc(Throwable e, Class<T> c)	Searches the causal chain of the specified throwable for a cause of the specified type.
static float[]	floats(float... v)	Creates a float[] from the specified values.
static String	fnb(String... v)	Returns the first non-blank string from the specified values.
static String	fne(String... v)	Returns the first non-empty string from the specified values.
static Supplier<String>	fs(String p, Object... a)	Returns a supplier that lazily formats a printf-style message (deferred until Supplier.get()).
static String	gst(Throwable t)	Returns the stack trace of the specified throwable as a string.
static <T extends Comparable<T>> boolean	gt(T a, T b)	Returns true if the first comparable is greater than the second.
static <T extends Throwable> T	gtc(Class<T> c, Throwable t)	Returns the first cause of the specified type from the throwable's causal chain.
static <T extends Comparable<T>> boolean	gte(T a, T b)	Returns true if the first comparable is greater than or equal to the second.
static int	h(Object... v)	Computes a hash code over the specified values.
static <T> Set<T>	hs(T... v)	Creates a mutable HashSet from the specified elements.
static IllegalArgumentException	iaex(String m, Object... a)	Creates an IllegalArgumentException with a formatted message.
static IllegalArgumentException	iaex(Throwable t)	Creates an IllegalArgumentException wrapping a cause.
static IllegalArgumentException	iaex(Throwable t, String m, Object... a)	Creates an IllegalArgumentException with a cause and formatted message.
static boolean	ib(String s)	Returns true if the specified string is null, empty, or whitespace-only.
static String	id(Object o)	Returns the system identity string of the specified object.
static boolean	ie(CharSequence s)	Returns true if the specified character sequence is null or empty.
static boolean	ie(Object o)	Returns true if the specified object is null or empty (string/collection/map/array).
static boolean	ie(Collection<?> c)	Returns true if the specified collection is null or empty.
static boolean	ie(Map<?,?> m)	Returns true if the specified map is null or empty.
static <K, V> Map<K,V>	im()	Creates an unmodifiable, empty map.
static <K, V> Map<K,V>	im(K k1, V v1)	Creates an unmodifiable map with 1 entry.
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2)	Creates an unmodifiable map with 2 entries.
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3)	Creates an unmodifiable map with 3 entries.
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)	Creates an unmodifiable map with 4 entries (keys/values in alternating order).
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)	Creates an unmodifiable map with 5 entries (keys/values in alternating order).
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)	Creates an unmodifiable map with 6 entries (keys/values in alternating order).
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)	Creates an unmodifiable map with 7 entries (keys/values in alternating order).
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)	Creates an unmodifiable map with 8 entries (keys/values in alternating order).
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)	Creates an unmodifiable map with 9 entries (keys/values in alternating order).
static <K, V> Map<K,V>	im(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)	Creates an unmodifiable map with 10 entries (keys/values in alternating order).
static boolean	inb(String s)	Returns true if the specified string contains non-whitespace content.
static boolean	ine(CharSequence s)	Returns true if the specified character sequence is not null and not empty.
static boolean	ine(Object o)	Returns true if the specified object is not null and not empty.
static boolean	ine(Collection<?> c)	Returns true if the specified collection is not null and not empty.
static boolean	ine(Map<?,?> m)	Returns true if the specified map is not null and not empty.
static int[]	ints(int... v)	Creates an int[] from the specified values.
static IOException	ioex(String m, Object... a)	Creates an IOException with a formatted message.
static IOException	ioex(Throwable t)	Creates an IOException wrapping a cause.
static IOException	ioex(Throwable t, String m, Object... a)	Creates an IOException with a cause and formatted message.
static IllegalStateException	isex(String m, Object... a)	Creates an IllegalStateException with a formatted message.
static IllegalStateException	isex(Throwable t)	Creates an IllegalStateException wrapping a cause.
static IllegalStateException	isex(Throwable t, String m, Object... a)	Creates an IllegalStateException with a cause and formatted message.
static <E> Set<E>	ist(E... v)	Creates an unmodifiable set from the specified elements.
static String	jn(String... v)	Concatenates the specified strings.
static <T> List<T>	l(T... x)	Creates a modifiable ArrayList from the specified elements.
static <E> Lists<E>	lb(Class<E> type)	Creates a new Lists builder for the specified element type.
static String	lc(String s)	Converts the specified string to lower case (null-safe).
static String	lcr(String s)	Converts the specified string to lower case using Locale.ROOT (null-safe).
static int	len(Object v)	Returns the length/size of the specified object (array/collection/map/string).
static <T> List<T>	ll(T... v)	Creates a mutable LinkedList from the specified elements.
static String	lm(Throwable t)	Returns the localized message of the specified throwable.
static long[]	longs(long... v)	Creates a long[] from the specified values.
static <E> List<E>	los(int n)	Creates a modifiable, empty ArrayList presized to the specified capacity.
static <T extends Comparable<T>> boolean	lt(T a, T b)	Returns true if the first comparable is less than the second.
static <T extends Comparable<T>> boolean	lte(T a, T b)	Returns true if the first comparable is less than or equal to the second.
static <K, V> Map<K,V>	m()	Creates an empty modifiable map.
static <K, V> Map<K,V>	m(K k1, V v1)	Creates a modifiable map with 1 entry.
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2)	Creates a modifiable map with 2 entries.
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3)	Creates a modifiable map with 3 entries.
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)	Creates a modifiable map with 4 entries (keys/values in alternating order).
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)	Creates a modifiable map with 5 entries (keys/values in alternating order).
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6)	Creates a modifiable map with 6 entries (keys/values in alternating order).
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7)	Creates a modifiable map with 7 entries (keys/values in alternating order).
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8)	Creates a modifiable map with 8 entries (keys/values in alternating order).
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9)	Creates a modifiable map with 9 entries (keys/values in alternating order).
static <K, V> Map<K,V>	m(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5, K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10)	Creates a modifiable map with 10 entries (keys/values in alternating order).
static <K, V> Maps<K,V>	mb()	Creates a new Maps builder.
static <K, V> Maps<K,V>	mb(Class<K> keyType, Class<V> valueType)	Creates a new Maps builder for the specified key and value types.
static String	mf(String p, Object... a)	Formats a message using MessageFormat-style {0} placeholders.
static Supplier<String>	mfs(String p, Object... a)	Returns a supplier that lazily formats a MessageFormat-style message (deferred until Supplier.get()).
static boolean	n(Object... v)	Returns true if the specified array is null or any of its elements are null.
static <T> boolean	n(T v)	Returns true if the specified value is null.
static <T> T[]	na(Class<T> t)	Returns null typed as an array of the specified component type.
static <T> boolean	neq(T a, T b)	Returns true if the two objects are not equal (null-safe).
static <T, U> boolean	neq(T a, U b, BiPredicate<T,U> t)	Returns true if the two objects are not equal using the specified equality test.
static boolean	neqic(String a, String b)	Returns true if the two strings are not equal ignoring case (null-safe).
static String	nie(String s)	Returns null if the specified string is empty, else the string.
static <E> List<E>	nie(List<E> v)	Returns null if the specified list is empty, else the list.
static <K, V> Map<K,V>	nie(Map<K,V> v)	Returns null if the specified map is empty, else the map.
static <E> Set<E>	nie(Set<E> v)	Returns null if the specified set is empty, else the set.
static <T, R> R	nm(T v, Function<? super T,? extends R> m)	Null-safe map: returns null when the value is null, else the mapper's result.
static <T extends Number> boolean	nm1(T v)	Returns true if the specified number is non-null and not equal to -1.
static boolean	nn(Object o)	Returns true if the specified object is not null.
static boolean	not(boolean v)	Returns the logical negation of the specified boolean.
static <T> Optional<T>	o(List<T> l, int i)	Returns the element at the specified index of a list as an Optional.
static <T> Optional<T>	o(T t)	Wraps the specified value in an Optional.
static <T> Optional<T>	oe()	Returns an empty Optional.
static <T> T	oo(Optional<T> o, T d)	Returns the value of the optional, or the specified default if empty.
static <T> T	or(T... t)	Returns the first non-null argument, or null if all are null.
static void	quiet(Snippet s)	Runs the specified snippet, silently swallowing any thrown exception.
static String	r(Object o)	Returns a human-readable string representation of the specified object.
static void	req(boolean expression, String msg, Object... args)	Throws an IllegalArgumentException if the specified expression is false.
static <E> Class<E>[]	reqcat(String name, Class<E> type, Class<?>[] value)	Throws an IllegalArgumentException if any element of the specified class array is not a subtype of the specified type.
static String	reqnb(String name, String o)	Throws an IllegalArgumentException if the specified string argument is null or blank.
static void	reqnn(String name1, Object o1, String name2, Object o2)	Throws an IllegalArgumentException if either of the specified arguments is null.
static void	reqnn(String name1, Object o1, String name2, Object o2, String name3, Object o3)	Throws an IllegalArgumentException if any of the three specified arguments is null.
static void	reqnn(String name1, Object o1, String name2, Object o2, String name3, Object o3, String name4, Object o4)	Throws an IllegalArgumentException if any of the four specified arguments is null.
static void	reqnn(String name1, Object o1, String name2, Object o2, String name3, Object o3, String name4, Object o4, String name5, Object o5)	Throws an IllegalArgumentException if any of the five specified arguments is null.
static <T> T	reqnn(String name, T o)	Throws an IllegalArgumentException if the specified argument is null.
static <T, C extends Collection<T>> C	reqnns(String name, C collection)	Throws an IllegalArgumentException if the specified collection argument or any of its elements is null.
static <T> T[]	reqnns(String name, T[] o)	Throws an IllegalArgumentException if the specified array argument or any of its elements is null.
static <T> T	reqt(Class<T> type, Object o)	Throws an IllegalArgumentException if the specified object is not an instance of the specified type.
static <T> T	reqt(Class<T> type, Object o, Supplier<? extends RuntimeException> exceptionSupplier)	Throws the exception provided by the supplier if the specified object is not an instance of the specified type.
static RuntimeException	rex(String m, Object... a)	Creates a RuntimeException with a formatted message.
static RuntimeException	rex(Throwable t)	Creates a RuntimeException wrapping a cause.
static RuntimeException	rex(Throwable t, String m, Object... a)	Creates a RuntimeException with a cause and formatted message.
static <T> T	rnn(T v)	Returns the specified value, throwing NullPointerException if it is null.
static String	s(Object v)	Converts the specified object to its string representation (null-safe).
static boolean	sa(Constructor<?> c)	Makes the specified constructor accessible.
static boolean	sa(Field f)	Makes the specified field accessible.
static boolean	sa(Method m)	Makes the specified method accessible.
static StringBuilder	sb(Object v)	Creates a new StringBuilder initialized with the stringified form of the specified value.
static StringBuilder	sb(Object... v)	Creates a new StringBuilder with the stringified form of each specified value appended in order.
static short[]	shorts(int... v)	Creates a short[] from the specified int values.
static <E> SortedSet<E>	ss(E... v)	Creates a sorted TreeSet from the specified elements (null values filtered out).
static <T> Set<T>	st(T... v)	Creates a modifiable, insertion-ordered LinkedHashSet from the specified elements.
static <E> Sets<E>	stb(Class<E> type)	Creates a new Sets builder for the specified element type.
static boolean	sw(String s, String p)	Returns true if the string starts with the specified prefix (null-safe).
static int	sz(Object o)	Returns the size of the specified object (string/collection/map/array).
static <T> boolean	t(Predicate<T> p, T v)	Tests the specified value against the given predicate (null-safe).
static <E> List<E>	tl(Collection<E> v)	Creates a modifiable ArrayList copy of the specified collection.
static String	tr(String s)	Trims leading/trailing whitespace from the specified string (null-safe).
static <E> Set<E>	ts(Collection<E> v)	Creates a modifiable LinkedHashSet copy of the specified collection.
static <T> List<T>	u(List<? extends T> v)	Returns an unmodifiable view of the specified list.
static <K, V> Map<K,V>	u(Map<? extends K,? extends V> v)	Returns an unmodifiable view of the specified map.
static <T> Set<T>	u(Set<? extends T> v)	Returns an unmodifiable view of the specified set.
static <T> SortedSet<T>	u(SortedSet<T> v)	Returns an unmodifiable view of the specified sorted set.
static String	uc(String s)	Converts the specified string to upper case (null-safe).
static String	ucr(String s)	Converts the specified string to upper case using Locale.ROOT (null-safe).
static UnsupportedOperationException	uoex()	Creates an UnsupportedOperationException with the message "Not supported."
static UnsupportedOperationException	uoex(String m, Object... a)	Creates an UnsupportedOperationException with a formatted message.
static UnsupportedOperationException	uoex(Throwable t)	Creates an UnsupportedOperationException wrapping a cause.
static UnsupportedOperationException	uoex(Throwable t, String m, Object... a)	Creates an UnsupportedOperationException with a cause and formatted message.
static UnsupportedOperationException	uoroex()	Creates an UnsupportedOperationException with the message "Object is read only."

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Shorts

protected Shorts()

Constructor — this class is meant to be subclassed.

Method Details

nn

public static boolean nn(Object o)

Returns true if the specified object is not null.

Parameters:

o - The object to check.

Returns:

true if the object is not null.

See Also:

• ObjectUtils.isNotNull(Object)

n

public static <T> boolean n(T v)

Returns true if the specified value is null.

Type Parameters:

T - The value type.

Parameters:

v - The value to check.

Returns:

true if the value is null.

See Also:

• ObjectUtils.isNull(Object)

n

public static boolean n(Object... v)

Returns true if the specified array is null or any of its elements are null.

Parameters:

v - The values to check.

Returns:

true if the array is null or contains a null element.

See Also:

• ObjectUtils.isNull(Object...)

eq

public static <T> boolean eq(T a,
 T b)

Returns true if the two objects are equal (null-safe).

Type Parameters:

T - The object type.

Parameters:

a - The first object.

b - The second object.

Returns:

true if the objects are equal.

See Also:

• ObjectUtils.equal(Object,Object)

eq

public static boolean eq(boolean ci,
 String a,
 String b)

Returns true if the two strings are equal, optionally ignoring case.

Parameters:

ci - If true, comparison is case-insensitive.

a - The first string.

b - The second string.

Returns:

true if the strings are equal.

See Also:

• ObjectUtils.equal(boolean,String,String)

eq

public static <T,
U> boolean eq(T a,
 U b,
 BiPredicate<T,U> t)

Returns true if the two objects are equal using the specified equality test.

Type Parameters:

T - The first object type.

U - The second object type.

Parameters:

a - The first object.

b - The second object.

t - The equality predicate.

Returns:

true if the objects are equal per the predicate.

See Also:

• ObjectUtils.equal(Object,Object,BiPredicate)

eqa

@SafeVarargs
public static <T> boolean eqa(T a,
 T... b)

Returns true if the first object equals any of the remaining objects.

Type Parameters:

T - The object type.

Parameters:

a - The object to look for.

b - The candidate values.

Returns:

true if a match is found.

See Also:

• ObjectUtils.equalsAny(Object,Object...)

eqic

public static boolean eqic(Object a,
 Object b)

Returns true if the two objects are equal ignoring case (via their string forms).

Parameters:

a - The first object.

b - The second object.

Returns:

true if the objects are equal ignoring case.

See Also:

• ObjectUtils.equalIgnoreCase(Object,Object)

neq

public static <T> boolean neq(T a,
 T b)

Returns true if the two objects are not equal (null-safe).

Type Parameters:

T - The object type.

Parameters:

a - The first object.

b - The second object.

Returns:

true if the objects are not equal.

See Also:

• ObjectUtils.notEqual(Object,Object)

neq

public static <T,
U> boolean neq(T a,
 U b,
 BiPredicate<T,U> t)

Returns true if the two objects are not equal using the specified equality test.

Type Parameters:

T - The first object type.

U - The second object type.

Parameters:

a - The first object.

b - The second object.

t - The equality predicate.

Returns:

true if the objects are not equal per the predicate.

See Also:

• ObjectUtils.notEqual(Object,Object,BiPredicate)

cmp

public static int cmp(Object a,
 Object b)

Compares two objects for order (null-safe).

Parameters:

a - The first object.

b - The second object.

Returns:

A negative, zero, or positive integer as a is less than, equal to, or greater than b.

See Also:

• ObjectUtils.compare(Object,Object)

lt

public static <T extends Comparable<T>> boolean lt(T a,
 T b)

Returns true if the first comparable is less than the second.

Type Parameters:

T - The comparable type.

Parameters:

a - The first value.

b - The second value.

Returns:

true if a < b.

See Also:

• ObjectUtils.lessThan(Comparable,Comparable)

lte

public static <T extends Comparable<T>> boolean lte(T a,
 T b)

Returns true if the first comparable is less than or equal to the second.

Type Parameters:

T - The comparable type.

Parameters:

a - The first value.

b - The second value.

Returns:

true if a <= b.

See Also:

• ObjectUtils.lessThanOrEqual(Comparable,Comparable)

gt

public static <T extends Comparable<T>> boolean gt(T a,
 T b)

Returns true if the first comparable is greater than the second.

Type Parameters:

T - The comparable type.

Parameters:

a - The first value.

b - The second value.

Returns:

true if a > b.

See Also:

• ObjectUtils.greaterThan(Comparable,Comparable)

gte

public static <T extends Comparable<T>> boolean gte(T a,
 T b)

Returns true if the first comparable is greater than or equal to the second.

Type Parameters:

T - The comparable type.

Parameters:

a - The first value.

b - The second value.

Returns:

true if a >= b.

See Also:

• ObjectUtils.greaterThanOrEqual(Comparable,Comparable)

or

@SafeVarargs
public static <T> T or(T... t)

Returns the first non-null argument, or null if all are null.

Type Parameters:

T - The value type.

Parameters:

t - The candidate values in priority order.

Returns:

The first non-null value, or null.

See Also:

• ObjectUtils.coalesce(Object...)

any

public static boolean any(boolean... v)

Returns true if any of the specified booleans are true.

Parameters:

v - The booleans to check.

Returns:

true if at least one value is true.

See Also:

• ObjectUtils.anyTrue(boolean...)

nm

public static <T,
R> R nm(T v,
 Function<? super T,? extends R> m)

Null-safe map: returns null when the value is null, else the mapper's result.

Replaces x == null ? null : f(x). This is not or(Object...), which returns its first non-null argument (so x, not f(x)) and evaluates f(x) even when x is null.

Type Parameters:

T - The value type.

R - The result type.

Parameters:

v - The value to map. Can be null.

m - The mapping function; never called with null.

Returns:

The mapped value, or null.

See Also:

• ObjectUtils.mapOrNull(Object, Function)

and

@SafeVarargs
public static boolean and(boolean... v)

Returns true if all of the specified booleans are true.

Parameters:

v - The booleans to check.

Returns:

true if every value is true.

See Also:

• ObjectUtils.allTrue(boolean...)

not

public static boolean not(boolean v)

Returns the logical negation of the specified boolean.

Parameters:

v - The value to negate.

Returns:

!v.

See Also:

• ObjectUtils.negate(boolean)

b

public static boolean b(Object v)

Converts the specified object to a boolean.

Parameters:

v - The value to convert.

Returns:

The boolean value.

See Also:

• ObjectUtils.toBoolean(Object)

s

public static String s(Object v)

Converts the specified object to its string representation (null-safe).

Parameters:

v - The value to stringify.

Returns:

The string form, or null if the value is null.

See Also:

• ObjectUtils.stringify(Object)

id

public static String id(Object o)

Returns the system identity string of the specified object.

Parameters:

o - The object. Can be null (returns null).

Returns:

The identity string (class name + identity hashcode), or null if the object is null.

See Also:

• ObjectUtils.identity(Object)

btw

public static boolean btw(int n,
 int lo,
 int hi)

Returns true if the specified integer is within the inclusive range.

Parameters:

n - The value to test.

lo - The inclusive lower bound.

hi - The inclusive upper bound.

Returns:

true if lo <= n <= hi.

See Also:

• ObjectUtils.isBetween(int,int,int)

nm1

public static <T extends Number> boolean nm1(T v)

Returns true if the specified number is non-null and not equal to -1.

Type Parameters:

T - The number type.

Parameters:

v - The value to test.

Returns:

true if the value is not -1.

See Also:

• ObjectUtils.isNotMinusOne(Number)

h

public static int h(Object... v)

Computes a hash code over the specified values.

Parameters:

v - The values to hash. Must not be null (a null array throws IllegalArgumentException).

Returns:

The combined hash code.

See Also:

• ObjectUtils.hash(Object...)

ie

public static boolean ie(Object o)

Returns true if the specified object is null or empty (string/collection/map/array).

Parameters:

o - The object to check.

Returns:

true if the object is null or empty.

See Also:

• ObjectUtils.isEmpty(Object)

ine

public static boolean ine(Object o)

Returns true if the specified object is not null and not empty.

Parameters:

o - The object to check.

Returns:

true if the object is non-empty.

See Also:

• ObjectUtils.isNotEmpty(Object)

o

public static <T> Optional<T> o(T t)

Wraps the specified value in an Optional.

Type Parameters:

T - The value type.

Parameters:

t - The value (may be null).

Returns:

An optional containing the value, or empty if null.

See Also:

• ObjectUtils.optional(Object)

o

public static <T> Optional<T> o(List<T> l,
 int i)

Returns the element at the specified index of a list as an Optional.

Type Parameters:

T - The element type.

Parameters:

l - The list.

i - The index.

Returns:

An optional containing the element, or empty if out of bounds.

See Also:

• CollectionUtils.optionalAt(List,int)

oe

public static <T> Optional<T> oe()

Returns an empty Optional.

Type Parameters:

T - The value type.

Returns:

An empty optional.

See Also:

• ObjectUtils.emptyOptional()

oo

public static <T> T oo(Optional<T> o,
 T d)

Returns the value of the optional, or the specified default if empty.

Type Parameters:

T - The value type.

Parameters:

o - The optional.

d - The default value.

Returns:

The optional's value, or d if empty.

See Also:

• ObjectUtils.orElse(Optional,Object)

rnn

public static <T> T rnn(T v)

Returns the specified value, throwing NullPointerException if it is null.

Type Parameters:

T - The value type.

Parameters:

v - The value.

Returns:

The non-null value.

See Also:

• ObjectUtils.requireNonNull(Object)

sz

public static int sz(Object o)

Returns the size of the specified object (string/collection/map/array).

Parameters:

o - The object.

Returns:

The size, or 0 if null.

See Also:

• ObjectUtils.size(Object)

req

public static void req(boolean expression,
 String msg,
 Object... args)
                throws IllegalArgumentException

Throws an IllegalArgumentException if the specified expression is false.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder timeout(Duration value) { req(! value.isNegative(), "Argument 'value' cannot be negative: %s", value); ... }

Parameters:

expression - The boolean expression to check.

msg - The exception message format string (see StringUtils.format(String, Object...)).

args - The exception message args.

Throws:

IllegalArgumentException - If the expression is false.

reqnn

public static <T> T reqnn(String name,
 T o)
                   throws IllegalArgumentException

Throws an IllegalArgumentException if the specified argument is null.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder timeout(Duration value) { timeout = reqnn("value", value); return this; }

Type Parameters:

T - The argument data type.

Parameters:

name - The argument name.

o - The object to check.

Returns:

The same argument.

Throws:

IllegalArgumentException - If the argument is null.

reqnn

public static void reqnn(String name1,
 Object o1,
 String name2,
 Object o2)
                  throws IllegalArgumentException

Throws an IllegalArgumentException if either of the specified arguments is null.

Arguments are checked in order, so the exception names the first null argument.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Foo(String name, Object value) { reqnn("name", name, "value", value); ... }

Parameters:

name1 - The first argument name.

o1 - The first object to check.

name2 - The second argument name.

o2 - The second object to check.

Throws:

IllegalArgumentException - If any argument is null.

reqnn

public static void reqnn(String name1,
 Object o1,
 String name2,
 Object o2,
 String name3,
 Object o3)
                  throws IllegalArgumentException

Throws an IllegalArgumentException if any of the three specified arguments is null.

Arguments are checked in order, so the exception names the first null argument.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; reqnn("a", a, "b", b, "c", c);

Parameters:

name1 - The first argument name.

o1 - The first object to check.

name2 - The second argument name.

o2 - The second object to check.

name3 - The third argument name.

o3 - The third object to check.

Throws:

IllegalArgumentException - If any argument is null.

reqnn

public static void reqnn(String name1,
 Object o1,
 String name2,
 Object o2,
 String name3,
 Object o3,
 String name4,
 Object o4)
                  throws IllegalArgumentException

Throws an IllegalArgumentException if any of the four specified arguments is null.

Arguments are checked in order, so the exception names the first null argument.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; reqnn("a", a, "b", b, "c", c, "d", d);

Parameters:

name1 - The first argument name.

o1 - The first object to check.

name2 - The second argument name.

o2 - The second object to check.

name3 - The third argument name.

o3 - The third object to check.

name4 - The fourth argument name.

o4 - The fourth object to check.

Throws:

IllegalArgumentException - If any argument is null.

reqnn

public static void reqnn(String name1,
 Object o1,
 String name2,
 Object o2,
 String name3,
 Object o3,
 String name4,
 Object o4,
 String name5,
 Object o5)
                  throws IllegalArgumentException

Throws an IllegalArgumentException if any of the five specified arguments is null.

Arguments are checked in order, so the exception names the first null argument.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; reqnn("a", a, "b", b, "c", c, "d", d, "e", e);

Parameters:

name1 - The first argument name.

o1 - The first object to check.

name2 - The second argument name.

o2 - The second object to check.

name3 - The third argument name.

o3 - The third object to check.

name4 - The fourth argument name.

o4 - The fourth object to check.

name5 - The fifth argument name.

o5 - The fifth object to check.

Throws:

IllegalArgumentException - If any argument is null.

reqnb

public static String reqnb(String name,
 String o)
                    throws IllegalArgumentException

Throws an IllegalArgumentException if the specified string argument is null or blank.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder name(String value) { name = reqnb("value", value); return this; }

Parameters:

name - The argument name.

o - The string to check.

Returns:

The same string.

Throws:

IllegalArgumentException - If the string is null or blank.

reqnns

public static <T> T[] reqnns(String name,
 T[] o)
                      throws IllegalArgumentException

Throws an IllegalArgumentException if the specified array argument or any of its elements is null.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder tags(String...values) { tags = l(reqnns("values", values)); return this; }

Type Parameters:

T - The element type.

Parameters:

name - The argument name.

o - The array to check.

Returns:

The same array.

Throws:

IllegalArgumentException - If the array or any of its elements is null.

reqnns

public static <T,
C extends Collection<T>> C reqnns(String name,
 C collection)
                                            throws IllegalArgumentException

Throws an IllegalArgumentException if the specified collection argument or any of its elements is null.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder tags(List<String> values) { tags = tl(reqnns("values", values)); return this; }

Type Parameters:

T - The element type.

C - The collection type.

Parameters:

name - The argument name.

collection - The collection to check.

Returns:

The same collection.

Throws:

IllegalArgumentException - If the collection or any of its elements is null.

reqt

public static <T> T reqt(Class<T> type,
 Object o)
                  throws IllegalArgumentException

Throws an IllegalArgumentException if the specified object is not an instance of the specified type.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public void setValue(Object value) { String s = reqt(String.class, value); ... }

Type Parameters:

T - The expected type.

Parameters:

type - The expected class type. Must not be null (a null type throws IllegalArgumentException).

o - The object to check. Must not be null (a null object throws IllegalArgumentException).

Returns:

The object cast to the specified type.

Throws:

IllegalArgumentException - If the object is not an instance of the specified type, or if either argument is null.

reqt

public static <T> T reqt(Class<T> type,
 Object o,
 Supplier<? extends RuntimeException> exceptionSupplier)

Throws the exception provided by the supplier if the specified object is not an instance of the specified type.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public void setValue(Object value) { String s = reqt(String.class, value, () -> isex("Invalid value type")); ... }

Type Parameters:

T - The expected type.

Parameters:

type - The expected class type. Must not be null (a null type throws IllegalArgumentException).

o - The object to check. Must not be null (a null object throws IllegalArgumentException).

exceptionSupplier - The supplier that provides the exception to throw if validation fails. Must not be null.

Returns:

The object cast to the specified type.

Throws:

RuntimeException - If the object is not an instance of the specified type (the exception is provided by the supplier).

reqcat

public static <E> Class<E>[] reqcat(String name,
 Class<E> type,
 Class<?>[] value)
                             throws IllegalArgumentException

Throws an IllegalArgumentException if any element of the specified class array is not a subtype of the specified type.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Builder serializers(Class<?>...values) { serializers = reqcat("values", Serializer.class, values); return this; }

Type Parameters:

E - The element type.

Parameters:

name - The argument name.

type - The expected parent class. Must not be null (unguarded — a null type throws NullPointerException).

value - The array value being checked. Must not be null (unguarded — a null array throws NullPointerException).

Returns:

The value cast to the specified array type.

Throws:

IllegalArgumentException - If any element is not a subtype of the specified type.

chk

public static void chk(boolean expression,
 String msg,
 Object... args)
                throws IllegalStateException

Throws an IllegalStateException if the specified expression is false.

The state-check counterpart of req(boolean, String, Object...): use it for object or lifecycle state rather than method arguments.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public void start() { chk(! started, "Already started: %s", name); ... }

Parameters:

expression - The boolean expression to check.

msg - The exception message format string (see StringUtils.format(String, Object...)).

args - The exception message args.

Throws:

IllegalStateException - If the expression is false.

chknn

public static <T> T chknn(T o,
 String msg,
 Object... args)
                   throws IllegalStateException

Throws an IllegalStateException if the specified object is null.

The state-check counterpart of reqnn(String, Object): use it for object or lifecycle state rather than method arguments.

Example:

import static org.apache.juneau.commons.utils.Shorts.*; public Connection connection() { return chknn(connection, "Not connected: %s", name); }

Type Parameters:

T - The object type.

Parameters:

o - The object to check. Can be null.

msg - The exception message format string (see StringUtils.format(String, Object...)).

args - The exception message args.

Returns:

The same object.

Throws:

IllegalStateException - If the object is null.

ie

public static boolean ie(CharSequence s)

Returns true if the specified character sequence is null or empty.

Parameters:

s - The sequence to check.

Returns:

true if null or zero-length.

See Also:

• StringUtils.isEmpty(CharSequence)

ine

public static boolean ine(CharSequence s)

Returns true if the specified character sequence is not null and not empty.

Parameters:

s - The sequence to check.

Returns:

true if non-empty.

See Also:

• StringUtils.isNotEmpty(CharSequence)

f

public static String f(String p,
 Object... a)

Formats a message using printf-style (%s/%d/…) placeholders.

For MessageFormat-style ({0}) patterns, use mf(String,Object...).

Parameters:

p - The pattern.

a - The arguments.

Returns:

The formatted string.

See Also:

• StringUtils.format(String,Object...)

fs

public static Supplier<String> fs(String p,
 Object... a)

Returns a supplier that lazily formats a printf-style message (deferred until Supplier.get()).

For MessageFormat-style ({0}) patterns, use mfs(String,Object...).

Parameters:

p - The pattern.

a - The arguments.

Returns:

A supplier of the formatted string.

See Also:

• StringUtils.format(String,Object...)

mf

public static String mf(String p,
 Object... a)

Formats a message using MessageFormat-style {0} placeholders.

MessageFormat counterpart to f(String,Object...), for patterns that genuinely need MessageFormat semantics (e.g. externally-authored i18n .properties strings).

Parameters:

p - The pattern.

a - The arguments.

Returns:

The formatted string.

See Also:

• StringUtils.mformat(String,Object...)

mfs

public static Supplier<String> mfs(String p,
 Object... a)

Returns a supplier that lazily formats a MessageFormat-style message (deferred until Supplier.get()).

Parameters:

p - The pattern.

a - The arguments.

Returns:

A supplier of the formatted string.

See Also:

• StringUtils.mformat(String,Object...)

r

public static String r(Object o)

Returns a human-readable string representation of the specified object.

Parameters:

o - The object. Can be null (returns null).

Returns:

The readable representation, or null if the object is null.

See Also:

• StringUtils.readable(Object)

ib

public static boolean ib(String s)

Returns true if the specified string is null, empty, or whitespace-only.

Parameters:

s - The string to check.

Returns:

true if blank.

See Also:

• StringUtils.isBlank(CharSequence)

inb

public static boolean inb(String s)

Returns true if the specified string contains non-whitespace content.

Parameters:

s - The string to check.

Returns:

true if not blank.

See Also:

• StringUtils.isNotBlank(CharSequence)

lc

public static String lc(String s)

Converts the specified string to lower case (null-safe).

Parameters:

s - The string.

Returns:

The lower-cased string, or null if null.

See Also:

• StringUtils.lowerCase(String)

lcr

public static String lcr(String s)

Converts the specified string to lower case using Locale.ROOT (null-safe).

Locale-independent — use for parse/match/normalize/key-fold code paths (as opposed to lc(String), which uses the default locale and is intended for display casing).

Parameters:

s - The string.

Returns:

The lower-cased string, or null if null.

See Also:

• StringUtils.lowerCaseRoot(String)

uc

public static String uc(String s)

Converts the specified string to upper case (null-safe).

Parameters:

s - The string.

Returns:

The upper-cased string, or null if null.

See Also:

• StringUtils.upperCase(String)

ucr

public static String ucr(String s)

Converts the specified string to upper case using Locale.ROOT (null-safe).

Locale-independent — use for parse/match/normalize/key-fold code paths (as opposed to uc(String), which uses the default locale and is intended for display casing).

Parameters:

s - The string.

Returns:

The upper-cased string, or null if null.

See Also:

• StringUtils.upperCaseRoot(String)

tr

public static String tr(String s)

Trims leading/trailing whitespace from the specified string (null-safe).

Parameters:

s - The string.

Returns:

The trimmed string, or null if null.

See Also:

• StringUtils.trim(String)

sw

public static boolean sw(String s,
 String p)

Returns true if the string starts with the specified prefix (null-safe).

Parameters:

s - The string.

p - The prefix.

Returns:

true if it starts with the prefix.

See Also:

• StringUtils.startsWith(String,String)

ew

public static boolean ew(String s,
 String x)

Returns true if the string ends with the specified suffix (null-safe).

Parameters:

s - The string.

x - The suffix.

Returns:

true if it ends with the suffix.

See Also:

• StringUtils.endsWith(String,String)

co

public static boolean co(String s,
 String x)

Returns true if the string contains the specified substring (null-safe).

Parameters:

s - The string.

x - The substring.

Returns:

true if it contains the substring.

See Also:

• StringUtils.contains(String,String)

eqic

public static boolean eqic(String a,
 String b)

Returns true if the two strings are equal ignoring case (null-safe).

Parameters:

a - The first string.

b - The second string.

Returns:

true if equal ignoring case.

See Also:

• StringUtils.equalsIgnoreCase(String,String)

neqic

public static boolean neqic(String a,
 String b)

Returns true if the two strings are not equal ignoring case (null-safe).

Parameters:

a - The first string.

b - The second string.

Returns:

true if not equal ignoring case.

See Also:

• StringUtils.notEqualsIgnoreCase(String,String)

ein

public static String ein(String s)

Returns an empty string if the specified string is null, else the string.

Parameters:

s - The string.

Returns:

The string, or an empty string if null.

See Also:

• StringUtils.emptyIfNull(String)

ein

public static String ein(Object o)

Returns an empty string if the specified object is null, else its string form.

Parameters:

o - The object.

Returns:

The string form, or an empty string if null.

See Also:

• StringUtils.emptyIfNull(Object)

bin

public static String bin(String s)

Returns a blank (single-space) string if the specified string is null, else the string.

Parameters:

s - The string.

Returns:

The string, or a blank string if null.

See Also:

• StringUtils.blankIfNull(String)

nie

public static String nie(String s)

Returns null if the specified string is empty, else the string.

Parameters:

s - The string.

Returns:

The string, or null if empty.

See Also:

• StringUtils.nullIfEmpty(String)

sb

public static StringBuilder sb(Object v)

Creates a new StringBuilder initialized with the stringified form of the specified value.

Parameters:

v - The initial value. Can be null (renders as "null").

Returns:

A new string builder.

See Also:

• StringUtils.newStringBuilder(Object)

sb

public static StringBuilder sb(Object... v)

Creates a new StringBuilder with the stringified form of each specified value appended in order.

Parameters:

v - The values to append in order (empty builder for no args).

Returns:

A new string builder.

See Also:

• StringUtils.newStringBuilder(Object...)

cn

public static String cn(Object o)

Returns the fully-qualified class name of the specified object (null-safe).

Parameters:

o - The object.

Returns:

The class name, or null if the object is null.

See Also:

• ClassUtils.className(Object)

cns

public static String cns(Object o)

Returns the simple class name of the specified object (null-safe).

Parameters:

o - The object.

Returns:

The simple class name, or null if the object is null.

See Also:

• ClassUtils.classNameSimple(Object)

cnsq

public static String cnsq(Object o)

Returns the qualified simple class name of the specified object (includes enclosing classes).

Parameters:

o - The object.

Returns:

The qualified simple class name.

See Also:

• ClassUtils.classNameSimpleQualified(Object)

fne

@SafeVarargs
public static String fne(String... v)

Returns the first non-empty string from the specified values.

Parameters:

v - The candidate strings.

Returns:

The first non-empty string, or null if all are empty.

See Also:

• StringUtils.firstNonEmpty(String...)

fnb

@SafeVarargs
public static String fnb(String... v)

Returns the first non-blank string from the specified values.

Parameters:

v - The candidate strings.

Returns:

The first non-blank string, or null if all are blank.

See Also:

• StringUtils.firstNonBlank(String...)

jn

@SafeVarargs
public static String jn(String... v)

Concatenates the specified strings.

Parameters:

v - The strings to join.

Returns:

The concatenated string.

See Also:

• StringUtils.join(String...)

a

@SafeVarargs
public static <T> T[] a(T... x)

Creates an array from the specified elements.

Type Parameters:

T - The element type.

Parameters:

x - The elements. Can be null (returned as-is).

Returns:

A new array, or null if the array was null.

See Also:

• CollectionUtils.array(Object...)

l

@SafeVarargs
public static <T> List<T> l(T... x)

Creates a modifiable ArrayList from the specified elements.

Type Parameters:

T - The element type.

Parameters:

x - The elements. Can be null (returns null).

Returns:

A new modifiable list, or null if the array was null.

See Also:

• CollectionUtils.list(Object...)

m

public static <K,
V> Map<K,V> m()

Creates an empty modifiable map.

Type Parameters:

K - The key type.

V - The value type.

Returns:

An empty modifiable map.

See Also:

• CollectionUtils.map()

m

public static <K,
V> Map<K,V> m(K k1,
 V v1)

Creates a modifiable map with 1 entry.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - The key.

v1 - The value.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2)

Creates a modifiable map with 2 entries.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - The first key.

v1 - The first value.

k2 - The second key.

v2 - The second value.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3)

Creates a modifiable map with 3 entries.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - The first key.

v1 - The first value.

k2 - The second key.

v2 - The second value.

k3 - The third key.

v3 - The third value.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4)

Creates a modifiable map with 4 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2.

k3 - Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5)

Creates a modifiable map with 5 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3.

k4 - Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6)

Creates a modifiable map with 6 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3.

k4 - Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5. @param k6 Key 6. @param v6 Value 6.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7)

Creates a modifiable map with 7 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4.

k5 - Key 5. @param v5 Value 5. @param k6 Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7,
 K k8,
 V v8)

Creates a modifiable map with 8 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4.

k5 - Key 5. @param v5 Value 5. @param k6 Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7. @param k8 Key 8. @param v8 Value 8.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7,
 K k8,
 V v8,
 K k9,
 V v9)

Creates a modifiable map with 9 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5.

k6 - Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7. @param k8 Key 8. @param v8 Value 8. @param k9 Key 9. @param v9 Value 9.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

m

public static <K,
V> Map<K,V> m(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7,
 K k8,
 V v8,
 K k9,
 V v9,
 K k10,
 V v10)

Creates a modifiable map with 10 entries (keys/values in alternating order).

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5.

k6 - Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7. @param k8 Key 8. @param v8 Value 8. @param k9 Key 9. @param v9 Value 9. @param k10 Key 10. @param v10 Value 10.

Returns:

A modifiable map.

See Also:

• CollectionUtils.map(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

at

public static <E> E at(List<E> l,
 int i)

Returns the element at the specified index of a list (null-safe).

Type Parameters:

E - The element type.

Parameters:

l - The list.

i - The index.

Returns:

The element, or null if out of bounds.

See Also:

• CollectionUtils.elementAt(List,int)

na

public static <T> T[] na(Class<T> t)

Returns null typed as an array of the specified component type.

Intentional null return (e.g. for assertion testing).

Type Parameters:

T - The component type.

Parameters:

t - The component class.

Returns:

null.

See Also:

• CollectionUtils.nullArray(Class)

nie

public static <K,
V> Map<K,V> nie(Map<K,V> v)

Returns null if the specified map is empty, else the map.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

v - The map.

Returns:

The map, or null if empty.

See Also:

• CollectionUtils.nullIfEmpty(Map)

nie

public static <E> List<E> nie(List<E> v)

Returns null if the specified list is empty, else the list.

Type Parameters:

E - The element type.

Parameters:

v - The list.

Returns:

The list, or null if empty.

See Also:

• CollectionUtils.nullIfEmpty(List)

nie

public static <E> Set<E> nie(Set<E> v)

Returns null if the specified set is empty, else the set.

Type Parameters:

E - The element type.

Parameters:

v - The set.

Returns:

The set, or null if empty.

See Also:

• CollectionUtils.nullIfEmpty(Set)

ie

public static boolean ie(Collection<?> c)

Returns true if the specified collection is null or empty.

Parameters:

c - The collection.

Returns:

true if null or empty.

See Also:

• CollectionUtils.isEmpty(Collection)

ie

public static boolean ie(Map<?,?> m)

Returns true if the specified map is null or empty.

Parameters:

m - The map.

Returns:

true if null or empty.

See Also:

• CollectionUtils.isEmpty(Map)

ine

public static boolean ine(Collection<?> c)

Returns true if the specified collection is not null and not empty.

Parameters:

c - The collection.

Returns:

true if non-empty.

See Also:

• CollectionUtils.isNotEmpty(Collection)

ine

public static boolean ine(Map<?,?> m)

Returns true if the specified map is not null and not empty.

Parameters:

m - The map.

Returns:

true if non-empty.

See Also:

• CollectionUtils.isNotEmpty(Map)

a2

@SafeVarargs
public static <E> E[][] a2(E[]... v)

Creates a 2-dimensional array from the specified rows.

Type Parameters:

E - The element type.

Parameters:

v - The rows.

Returns:

A 2-dimensional array.

See Also:

• CollectionUtils.array2d(Object[][])

ao

public static Object[] ao(Object... v)

Creates an Object[] from the specified elements.

Parameters:

v - The elements.

Returns:

A new object array.

See Also:

• CollectionUtils.objectArray(Object...)

ll

@SafeVarargs
public static <T> List<T> ll(T... v)

Creates a mutable LinkedList from the specified elements.

Type Parameters:

T - The element type.

Parameters:

v - The elements.

Returns:

A new linked list.

See Also:

• CollectionUtils.linkedList(Object...)

hs

@SafeVarargs
public static <T> Set<T> hs(T... v)

Creates a mutable HashSet from the specified elements.

Type Parameters:

T - The element type.

Parameters:

v - The elements.

Returns:

A new hash set.

See Also:

• CollectionUtils.hashSet(Object...)

st

@SafeVarargs
public static <T> Set<T> st(T... v)

Creates a modifiable, insertion-ordered LinkedHashSet from the specified elements.

Type Parameters:

T - The element type.

Parameters:

v - The elements.

Returns:

A new modifiable set.

See Also:

• CollectionUtils.set(Object...)

ss

@SafeVarargs
public static <E> SortedSet<E> ss(E... v)

Creates a sorted TreeSet from the specified elements (null values filtered out).

Type Parameters:

E - The element type.

Parameters:

v - The elements.

Returns:

A new sorted set.

See Also:

• CollectionUtils.sortedSet(Object...)

tl

public static <E> List<E> tl(Collection<E> v)

Creates a modifiable ArrayList copy of the specified collection.

Type Parameters:

E - The element type.

Parameters:

v - The collection to copy from. Can be null (returns an empty list, not null).

Returns:

A new modifiable list.

See Also:

• CollectionUtils.toList(Collection)

ts

public static <E> Set<E> ts(Collection<E> v)

Creates a modifiable LinkedHashSet copy of the specified collection.

Type Parameters:

E - The element type.

Parameters:

v - The collection to copy from. Can be null (returns null).

Returns:

A new modifiable set, or null if the input was null.

See Also:

• CollectionUtils.toSet(Collection)

los

public static <E> List<E> los(int n)

Creates a modifiable, empty ArrayList presized to the specified capacity.

Type Parameters:

E - The element type.

Parameters:

n - The initial capacity.

Returns:

A new modifiable, empty list.

See Also:

• CollectionUtils.listOfSize(int)

ist

@SafeVarargs
public static <E> Set<E> ist(E... v)

Creates an unmodifiable set from the specified elements. Unlike Set.of(Object...), permits a null element and preserves insertion order.

Type Parameters:

E - The element type.

Parameters:

v - The elements. Must not be null (a null array throws IllegalArgumentException).

Returns:

A new unmodifiable set.

See Also:

• CollectionUtils.immutableSet(Object...)

im

public static <K,
V> Map<K,V> im()

Creates an unmodifiable, empty map.

Type Parameters:

K - The key type.

V - The value type.

Returns:

A new unmodifiable empty map.

See Also:

• CollectionUtils.immutableMap()

im

public static <K,
V> Map<K,V> im(K k1,
 V v1)

Creates an unmodifiable map with 1 entry. Unlike Map.of(Object,Object), permits a null key or value and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - The key.

v1 - The value.

Returns:

A new unmodifiable map.

See Also:

• CollectionUtils.immutableMap(Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2)

Creates an unmodifiable map with 2 entries. Unlike Map.of(Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - The first key.

v1 - The first value.

k2 - The second key.

v2 - The second value.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if k1 and k2 are duplicate keys.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3)

Creates an unmodifiable map with 3 entries. Unlike Map.of(Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - The first key.

v1 - The first value.

k2 - The second key.

v2 - The second value.

k3 - The third key.

v3 - The third value.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4)

Creates an unmodifiable map with 4 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2.

k3 - Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5)

Creates an unmodifiable map with 5 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3.

k4 - Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6)

Creates an unmodifiable map with 6 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3.

k4 - Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5. @param k6 Key 6. @param v6 Value 6.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7)

Creates an unmodifiable map with 7 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4.

k5 - Key 5. @param v5 Value 5. @param k6 Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7,
 K k8,
 V v8)

Creates an unmodifiable map with 8 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4.

k5 - Key 5. @param v5 Value 5. @param k6 Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7. @param k8 Key 8. @param v8 Value 8.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7,
 K k8,
 V v8,
 K k9,
 V v9)

Creates an unmodifiable map with 9 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5.

k6 - Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7. @param k8 Key 8. @param v8 Value 8. @param k9 Key 9. @param v9 Value 9.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

im

public static <K,
V> Map<K,V> im(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4,
 K k5,
 V v5,
 K k6,
 V v6,
 K k7,
 V v7,
 K k8,
 V v8,
 K k9,
 V v9,
 K k10,
 V v10)

Creates an unmodifiable map with 10 entries (keys/values in alternating order). Unlike Map.of(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object), permits null keys/values and preserves insertion order. Mutating the returned map (e.g. put/remove/clear) throws UnsupportedOperationException.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

k1 - Key 1. @param v1 Value 1. @param k2 Key 2. @param v2 Value 2. @param k3 Key 3. @param v3 Value 3. @param k4 Key 4. @param v4 Value 4. @param k5 Key 5. @param v5 Value 5.

k6 - Key 6. @param v6 Value 6. @param k7 Key 7. @param v7 Value 7. @param k8 Key 8. @param v8 Value 8. @param k9 Key 9. @param v9 Value 9. @param k10 Key 10. @param v10 Value 10.

Returns:

A new unmodifiable map.

Throws:

IllegalArgumentException - if any of the keys are duplicated.

See Also:

• CollectionUtils.immutableMap(Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object,Object)

u

public static <T> List<T> u(List<? extends T> v)

Returns an unmodifiable view of the specified list.

Type Parameters:

T - The element type.

Parameters:

v - The list. Can be null (returns null).

Returns:

An unmodifiable list, or null if the argument was null.

See Also:

• CollectionUtils.unmodifiable(List)

u

public static <K,
V> Map<K,V> u(Map<? extends K,? extends V> v)

Returns an unmodifiable view of the specified map.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

v - The map. Can be null (returns null).

Returns:

An unmodifiable map, or null if the argument was null.

See Also:

• CollectionUtils.unmodifiable(Map)

u

public static <T> Set<T> u(Set<? extends T> v)

Returns an unmodifiable view of the specified set.

Type Parameters:

T - The element type.

Parameters:

v - The set. Can be null (returns null).

Returns:

An unmodifiable set, or null if the argument was null.

See Also:

• CollectionUtils.unmodifiable(Set)

u

public static <T> SortedSet<T> u(SortedSet<T> v)

Returns an unmodifiable view of the specified sorted set.

Type Parameters:

T - The element type.

Parameters:

v - The sorted set. Can be null (returns null).

Returns:

An unmodifiable sorted set, or null if the argument was null.

See Also:

• CollectionUtils.unmodifiable(SortedSet)

len

public static int len(Object v)

Returns the length/size of the specified object (array/collection/map/string).

Parameters:

v - The object.

Returns:

The length, or 0 if null.

See Also:

• CollectionUtils.length(Object)

aa

@SafeVarargs
public static <E> List<E> aa(List<E> v,
 E... e)

Adds the specified elements to the given list and returns it.

Type Parameters:

E - The element type.

Parameters:

v - The list to add to. Can be null (a new list is created and returned).

e - The elements to add. Can be null (treated as a no-op — the value is returned unchanged).

Returns:

The same list (or a newly-created list if v was null).

See Also:

• CollectionUtils.addAll(List,Object...)

ints

public static int[] ints(int... v)

Creates an int[] from the specified values.

Parameters:

v - The values.

Returns:

A new int array.

See Also:

• CollectionUtils.intArray(int...)

longs

public static long[] longs(long... v)

Creates a long[] from the specified values.

Parameters:

v - The values.

Returns:

A new long array.

See Also:

• CollectionUtils.longArray(long...)

bytes

public static byte[] bytes(int... v)

Creates a byte[] from the specified int values.

Parameters:

v - The values.

Returns:

A new byte array.

See Also:

• CollectionUtils.byteArray(int...)

chars

public static char[] chars(char... v)

Creates a char[] from the specified values.

Parameters:

v - The values.

Returns:

A new char array.

See Also:

• CollectionUtils.charArray(char...)

floats

public static float[] floats(float... v)

Creates a float[] from the specified values.

Parameters:

v - The values.

Returns:

A new float array.

See Also:

• CollectionUtils.floatArray(float...)

doubles

public static double[] doubles(double... v)

Creates a double[] from the specified values.

Parameters:

v - The values.

Returns:

A new double array.

See Also:

• CollectionUtils.doubleArray(double...)

booleans

public static boolean[] booleans(boolean... v)

Creates a boolean[] from the specified values.

Parameters:

v - The values.

Returns:

A new boolean array.

See Also:

• CollectionUtils.booleanArray(boolean...)

shorts

public static short[] shorts(int... v)

Creates a short[] from the specified int values.

Parameters:

v - The values.

Returns:

A new short array.

See Also:

• CollectionUtils.shortArray(int...)

lb

public static <E> Lists<E> lb(Class<E> type)

Creates a new Lists builder for the specified element type.

Type Parameters:

E - The element type.

Parameters:

type - The element type.

Returns:

A new list builder.

See Also:

• CollectionUtils.listBuilder(Class)

mb

public static <K,
V> Maps<K,V> mb()

Creates a new Maps builder.

Type Parameters:

K - The key type.

V - The value type.

Returns:

A new map builder.

See Also:

• CollectionUtils.mapBuilder()

mb

public static <K,
V> Maps<K,V> mb(Class<K> keyType,
 Class<V> valueType)

Creates a new Maps builder for the specified key and value types.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

keyType - The key type.

valueType - The value type.

Returns:

A new map builder.

See Also:

• CollectionUtils.mapBuilder(Class,Class)

stb

public static <E> Sets<E> stb(Class<E> type)

Creates a new Sets builder for the specified element type.

Type Parameters:

E - The element type.

Parameters:

type - The element type.

Returns:

A new set builder.

See Also:

• CollectionUtils.setBuilder(Class)

cp

public static <E> Collection<E> cp(Collection<E> v)

Creates a new collection from the specified collection.

Type Parameters:

E - The element type.

Parameters:

v - The value to copy from. Can be null (returns null).

Returns:

A new LinkedHashSet, or null if the input was null.

See Also:

• CopyUtils.copyOf(Collection)

cp

public static <E> List<E> cp(List<E> v)

Returns a mutable copy of the specified list.

Type Parameters:

E - The element type.

Parameters:

v - The list to copy. Can be null (returns null).

Returns:

A new list containing the same elements, or null if the list was null.

See Also:

• CopyUtils.copyOf(List)

cp

public static <E> List<E> cp(List<E> v,
 Function<? super E,? extends E> valueMapper)

Makes a deep copy of the specified list, transforming each value.

Type Parameters:

E - The element type.

Parameters:

v - The list to copy.

valueMapper - The function to apply to each value in the list.

Returns:

A new transformed list, or null if the list being copied was null.

See Also:

• CopyUtils.copyOf(List,Function)

cp

public static <E> List<E> cp(List<E> v,
 Function<? super E,? extends E> valueMapper,
 Supplier<List<E>> listFactory)

Makes a deep copy of the specified list, transforming each value using the specified list factory.

Type Parameters:

E - The element type.

Parameters:

v - The list to copy.

valueMapper - The function to apply to each value in the list.

listFactory - The factory for creating the list.

Returns:

A new transformed list, or null if the list being copied was null.

See Also:

• CopyUtils.copyOf(List,Function,Supplier)

cp

public static <K,
V> Map<K,V> cp(Map<K,V> v)

Creates a new map from the specified map.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

v - The value to copy from. Can be null (returns null).

Returns:

A new LinkedHashMap, or null if the input was null.

See Also:

• CopyUtils.copyOf(Map)

cp

public static <K,
V> Map<K,V> cp(Map<K,V> v,
 Function<? super V,? extends V> valueMapper)

Makes a deep copy of the specified map, transforming each value.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

v - The map to copy.

valueMapper - The function to apply to each value in the map.

Returns:

A new transformed map, or null if the map being copied was null.

See Also:

• CopyUtils.copyOf(Map,Function)

cp

public static <K,
V> Map<K,V> cp(Map<K,V> v,
 Function<? super V,? extends V> valueMapper,
 Supplier<Map<K,V>> mapFactory)

Makes a deep copy of the specified map, transforming each value using the specified map factory.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

v - The map to copy.

valueMapper - The function to apply to each value in the map.

mapFactory - The factory for creating the map.

Returns:

A new transformed map, or null if the map being copied was null.

See Also:

• CopyUtils.copyOf(Map,Function,Supplier)

cp

public static <E> Set<E> cp(Set<E> v)

Creates a new set from the specified set.

Type Parameters:

E - The element type.

Parameters:

v - The value to copy from. Can be null (returns null).

Returns:

A new LinkedHashSet, or null if the input was null.

See Also:

• CopyUtils.copyOf(Set)

cp

public static <E> Set<E> cp(Set<E> v,
 Function<? super E,? extends E> valueMapper)

Makes a deep copy of the specified set, transforming each value.

Type Parameters:

E - The element type.

Parameters:

v - The set to copy.

valueMapper - The function to apply to each value in the set.

Returns:

A new transformed set, or null if the set being copied was null.

See Also:

• CopyUtils.copyOf(Set,Function)

cp

public static <E> Set<E> cp(Set<E> v,
 Function<? super E,? extends E> valueMapper,
 Supplier<Set<E>> setFactory)

Makes a deep copy of the specified set, transforming each value using the specified set factory.

Type Parameters:

E - The element type.

Parameters:

v - The set to copy.

valueMapper - The function to apply to each value in the set.

setFactory - The factory for creating sets.

Returns:

A new transformed set, or null if the set being copied was null.

See Also:

• CopyUtils.copyOf(Set,Function,Supplier)

cp

public static <T> T[] cp(T[] v)

Makes a copy of the specified array.

Type Parameters:

T - The element type.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(Object[])

cp

public static byte[] cp(byte[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(byte[])

cp

public static char[] cp(char[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(char[])

cp

public static int[] cp(int[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(int[])

cp

public static long[] cp(long[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(long[])

cp

public static short[] cp(short[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(short[])

cp

public static boolean[] cp(boolean[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(boolean[])

cp

public static double[] cp(double[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(double[])

cp

public static float[] cp(float[] v)

Makes a copy of the specified array.

Parameters:

v - The array to copy. Can be null (returns null).

Returns:

A new copy of the array, or null if the array was null.

See Also:

• CopyUtils.copyOf(float[])

cast

public static <T> T cast(Class<T> c,
 Object o)

Casts the specified object to the specified type (null-safe).

Type Parameters:

T - The target type.

Parameters:

c - The target class.

o - The object to cast.

Returns:

The cast object, or null if the object is null.

See Also:

• ClassUtils.castTo(Class,Object)

sa

public static boolean sa(Method m)

Makes the specified method accessible.

Parameters:

m - The method. Must not be null (a null argument throws IllegalArgumentException).

Returns:

true if the method was made accessible.

See Also:

• ClassUtils.setAccessible(Method)

sa

public static boolean sa(Field f)

Makes the specified field accessible.

Parameters:

f - The field. Must not be null (a null argument throws IllegalArgumentException).

Returns:

true if the field was made accessible.

See Also:

• ClassUtils.setAccessible(Field)

sa

public static boolean sa(Constructor<?> c)

Makes the specified constructor accessible.

Parameters:

c - The constructor. Must not be null (a null argument throws IllegalArgumentException).

Returns:

true if the constructor was made accessible.

See Also:

• ClassUtils.setAccessible(Constructor)

rex

public static RuntimeException rex(String m,
 Object... a)

Creates a RuntimeException with a formatted message.

rex

public static RuntimeException rex(Throwable t)

Creates a RuntimeException wrapping a cause.

rex

public static RuntimeException rex(Throwable t,
 String m,
 Object... a)

Creates a RuntimeException with a cause and formatted message.

iaex

public static IllegalArgumentException iaex(String m,
 Object... a)

Creates an IllegalArgumentException with a formatted message.

iaex

public static IllegalArgumentException iaex(Throwable t)

Creates an IllegalArgumentException wrapping a cause.

iaex

public static IllegalArgumentException iaex(Throwable t,
 String m,
 Object... a)

Creates an IllegalArgumentException with a cause and formatted message.

brex

public static BeanRuntimeException brex(String m,
 Object... a)

Creates a BeanRuntimeException with a formatted message.

brex

public static BeanRuntimeException brex(Throwable t)

Creates a BeanRuntimeException wrapping a cause.

brex

public static BeanRuntimeException brex(Throwable t,
 String m,
 Object... a)

Creates a BeanRuntimeException with a cause and formatted message.

brex

public static BeanRuntimeException brex(Class<?> c,
 String m,
 Object... a)

Creates a BeanRuntimeException with an associated class and formatted message.

brex

public static BeanRuntimeException brex(ClassInfo c,
 String m,
 Object... a)

Creates a BeanRuntimeException with an associated class and formatted message.

brex

public static BeanRuntimeException brex(Throwable t,
 Class<?> c,
 String m,
 Object... a)

Creates a BeanRuntimeException with a cause, associated class, and formatted message.

brex

public static BeanRuntimeException brex(Throwable t,
 ClassInfo c,
 String m,
 Object... a)

Creates a BeanRuntimeException with a cause, associated class, and formatted message.

ioex

public static IOException ioex(String m,
 Object... a)

Creates an IOException with a formatted message.

ioex

public static IOException ioex(Throwable t)

Creates an IOException wrapping a cause.

ioex

public static IOException ioex(Throwable t,
 String m,
 Object... a)

Creates an IOException with a cause and formatted message.

exex

public static ExecutableException exex(String m,
 Object... a)

Creates an ExecutableException with a formatted message.

exex

public static ExecutableException exex(Throwable t)

Creates an ExecutableException wrapping a cause.

exex

public static ExecutableException exex(Throwable t,
 String m,
 Object... a)

Creates an ExecutableException with a cause and formatted message.

isex

public static IllegalStateException isex(String m,
 Object... a)

Creates an IllegalStateException with a formatted message.

isex

public static IllegalStateException isex(Throwable t)

Creates an IllegalStateException wrapping a cause.

isex

public static IllegalStateException isex(Throwable t,
 String m,
 Object... a)

Creates an IllegalStateException with a cause and formatted message.

uoex

public static UnsupportedOperationException uoex()

Creates an UnsupportedOperationException with the message "Not supported."

uoex

public static UnsupportedOperationException uoex(String m,
 Object... a)

Creates an UnsupportedOperationException with a formatted message.

uoex

public static UnsupportedOperationException uoex(Throwable t)

Creates an UnsupportedOperationException wrapping a cause.

uoex

public static UnsupportedOperationException uoex(Throwable t,
 String m,
 Object... a)

Creates an UnsupportedOperationException with a cause and formatted message.

uoroex

public static UnsupportedOperationException uoroex()

Creates an UnsupportedOperationException with the message "Object is read only."

gst

public static String gst(Throwable t)

Returns the stack trace of the specified throwable as a string.

Parameters:

t - The throwable. Must not be null (a null argument throws NullPointerException).

Returns:

The stack trace string.

See Also:

• ThrowableUtils.getStackTrace(Throwable)

cex

public static <T> T cex(Class<T> c,
 Throwable t)

Casts the specified throwable to the specified type, wrapping if necessary.

Type Parameters:

T - The target type.

Parameters:

c - The target class. Must not be null.

t - The throwable. Can be null (produces a wrapper with a null cause).

Returns:

The cast (or wrapped) throwable.

See Also:

• ThrowableUtils.castException(Class,Throwable)

fc

public static <T extends Throwable> Optional<T> fc(Throwable e,
 Class<T> c)

Searches the causal chain of the specified throwable for a cause of the specified type.

Type Parameters:

T - The cause type.

Parameters:

e - The throwable to search. Can be null (returns an empty Optional).

c - The cause class to look for. Must not be null.

Returns:

An optional containing the matching cause, if found.

See Also:

• ThrowableUtils.findCause(Throwable,Class)

gtc

public static <T extends Throwable> T gtc(Class<T> c,
 Throwable t)

Returns the first cause of the specified type from the throwable's causal chain.

Type Parameters:

T - The cause type.

Parameters:

c - The cause class to look for. Must not be null.

t - The throwable to search. Can be null (returns null).

Returns:

The matching cause, or null if not found.

See Also:

• ThrowableUtils.getThrowableCause(Class,Throwable)

lm

public static String lm(Throwable t)

Returns the localized message of the specified throwable.

Parameters:

t - The throwable. Must not be null (a null argument throws NullPointerException).

Returns:

The localized message, or null if the throwable has no localized message.

See Also:

• ThrowableUtils.localizedMessage(Throwable)

quiet

public static void quiet(Snippet s)

Runs the specified snippet, silently swallowing any thrown exception.

Parameters:

s - The snippet to run.

See Also:

• ThrowableUtils.runQuietly(Snippet)

t

public static <T> boolean t(Predicate<T> p,
 T v)

Tests the specified value against the given predicate (null-safe).

Type Parameters:

T - The value type.

Parameters:

p - The predicate. Can be null (returns true).

v - The value to test. Can be null.

Returns:

The result of the predicate, or true if the predicate is null.

See Also:

• PredicateUtils.test(Predicate,Object)