Package com.intellij.util

Class ObjectUtils

java.lang.Object

com.intellij.util.ObjectUtils

public final class ObjectUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	NULL

Method Summary

Modifier and Type	Method and Description
static <T> void	assertAllElementsNotNull(T [] array)
static <T> T	assertNotNull(T t) Deprecated. Use Objects.requireNonNull(Object)
static int	binarySearch(int fromIndex, int toIndex, IntIntFunction indexComparator) Performs binary search on the range [fromIndex, toIndex)
static <T> T	chooseNotNull(T t1, T t2)
static <T> T	coalesce(java.lang.Iterable<? extends T> o)
static <T> T	coalesce(T t1, T t2)
static <T> T	coalesce(T t1, T t2, T t3)
static <T> void	consumeIfCast(java.lang.Object obj, java.lang.Class<T> clazz, Consumer<? super T> consumer)
static <T> void	consumeIfNotNull(T obj, Consumer<? super T> consumer)
static <T,S> S	doIfCast(java.lang.Object obj, java.lang.Class<T> clazz, Convertor<? super T,? extends S> convertor)
static <T,S> S	doIfNotNull(T obj, Function<? super T,? extends S> function)
static <T> T	notNull(T value) Deprecated. Use Objects.requireNonNull(Object)
static <T> T	notNull(T value, NotNullFactory<? extends T> defaultValue)
static <T> T	notNull(T value, T defaultValue)
static <T> T	nullizeByCondition(T obj, Condition<? super T> condition)
static <T> T	nullizeIfDefaultValue(T obj, T defaultValue)
static void	reachabilityFence(java.lang.Object o) They promise in http://mail.openjdk.java.net/pipermail/core-libs-dev/2018-February/051312.html that the object reference won't be removed by JIT and GC-ed until this call.
static java.lang.Object	sentinel(java.lang.String name) Creates a new object which could be used as sentinel value (special value to distinguish from any other object).
static <T> T	sentinel(java.lang.String name, java.lang.Class<T> ofInterface) Creates an instance of class ofInterface with its Object.toString() method returning name.
static <T> T	tryCast(java.lang.Object obj, java.lang.Class<T> clazz)

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final java.lang.Object NULL

See Also:

NotNullizer

Method Detail

sentinel

public static java.lang.Object sentinel(java.lang.String name)

Creates a new object which could be used as sentinel value (special value to distinguish from any other object). It does not equal to any other object. Usually should be assigned to the static final field.

Parameters:

name - an object name, returned from Object.toString() to simplify the debugging or heap dump analysis (guaranteed to be stored as sentinel object field). If sentinel is assigned to the static final field, it's recommended to supply that field name (possibly qualified with the class name).

Returns:

a new sentinel object

reachabilityFence

public static void reachabilityFence(java.lang.Object o)

They promise in http://mail.openjdk.java.net/pipermail/core-libs-dev/2018-February/051312.html that the object reference won't be removed by JIT and GC-ed until this call.

sentinel

public static <T> T sentinel(java.lang.String name,
                             java.lang.Class<T> ofInterface)

Creates an instance of class ofInterface with its Object.toString() method returning name. No other guarantees about return value behaviour. ofInterface must represent an interface class. Useful for stubs in generic code, e.g. for storing in List<T> to represent empty special value.

assertNotNull

@Deprecated
public static <T> T assertNotNull(T t)

Deprecated. Use Objects.requireNonNull(Object)

assertAllElementsNotNull

public static <T> void assertAllElementsNotNull(T [] array)

chooseNotNull

public static <T> T chooseNotNull(T t1,
                                  T t2)

coalesce

public static <T> T coalesce(T t1,
                             T t2)

coalesce

public static <T> T coalesce(T t1,
                             T t2,
                             T t3)

coalesce

public static <T> T coalesce(java.lang.Iterable<? extends T> o)

notNull

@Deprecated
public static <T> T notNull(T value)

Deprecated. Use Objects.requireNonNull(Object)

notNull

public static <T> T notNull(T value,
                            T defaultValue)

notNull

public static <T> T notNull(T value,
                            NotNullFactory<? extends T> defaultValue)

tryCast

public static <T> T tryCast(java.lang.Object obj,
                            java.lang.Class<T> clazz)

doIfCast

public static <T,S> S doIfCast(java.lang.Object obj,
                               java.lang.Class<T> clazz,
                               Convertor<? super T,? extends S> convertor)

doIfNotNull

public static <T,S> S doIfNotNull(T obj,
                                  Function<? super T,? extends S> function)

consumeIfNotNull

public static <T> void consumeIfNotNull(T obj,
                                        Consumer<? super T> consumer)

consumeIfCast

public static <T> void consumeIfCast(java.lang.Object obj,
                                     java.lang.Class<T> clazz,
                                     Consumer<? super T> consumer)

nullizeByCondition

public static <T> T nullizeByCondition(T obj,
                                       Condition<? super T> condition)

nullizeIfDefaultValue

public static <T> T nullizeIfDefaultValue(T obj,
                                          T defaultValue)

binarySearch

public static int binarySearch(int fromIndex,
                               int toIndex,
                               IntIntFunction indexComparator)

Performs binary search on the range [fromIndex, toIndex)

Parameters:

indexComparator - a comparator which receives a middle index and returns the result of comparision of the value at this index and the goal value (e.g 0 if found, -1 if the value[middleIndex] < goal, or 1 if value[middleIndex] > goal)

Returns:

index for which indexComparator returned 0 or -insertionIndex-1 if wasn't found

See Also:

Arrays.binarySearch(Object[], Object, Comparator), Collections.binarySearch(List, Object, Comparator)