Module org.microbean.invoke

Package org.microbean.invoke

Class BootstrapMethods

java.lang.Object

org.microbean.invoke.BootstrapMethods

public final class BootstrapMethods
extends Object

Useful constant bootstrap methods and methods that make sense to invoke from ConstantBootstraps.invoke(Lookup, String, Class, MethodHandle, Object...).

Author:

Laird Nelson

See Also:

• java.lang.invoke

Method Summary

Modifier and Type	Method	Description
static final ConstantCallSite	findConstructorCallSite(MethodHandles.Lookup lookup, String ignoredMethodName, MethodType methodType, Class<?> targetClass)	Returns a ConstantCallSite backed by a constructor MethodHandle.
static final ConstantCallSite	findSetterCallSite(MethodHandles.Lookup lookup, String fieldName, MethodType methodType, Class<?> targetClass)	Returns a ConstantCallSite backed by a setter MethodHandle.
static final ConstantCallSite	findStaticCallSiteAsSpreader(MethodHandles.Lookup lookup, String methodName, MethodType methodType, Class<?> targetClass)	Returns a ConstantCallSite backed by a static MethodHandle adapted to be an array-spreading MethodHandle.
static final ConstantCallSite	findStaticSetterCallSite(MethodHandles.Lookup lookup, String fieldName, MethodType methodType, Class<?> targetClass)	Returns a ConstantCallSite backed by a static setter MethodHandle.
static final ConstantCallSite	findVirtualCallSite(MethodHandles.Lookup lookup, String methodName, MethodType methodType, Class<?> targetClass)	Returns a ConstantCallSite backed by a virtual MethodHandle.
static final <K, V> SortedMap<K,V>	immutableEmptySortedMap(Comparator<? super K> comparator)	Returns an empty, immutable SortedMap.
static final <E> SortedSet<E>	immutableEmptySortedSet(Comparator<? super E> comparator)	Returns an immutable, empty SortedSet.
static final <K, V> SortedMap<K,V>	immutableSortedMapOf(Collection<? extends Map.Entry<K,V>> entries)	Given a Collection of Map.Entry instances, returns a SortedMap representing it that is immutable.
static final <K, V> SortedMap<K,V>	immutableSortedMapOf(Collection<? extends Map.Entry<K,V>> entries, Comparator<? super K> comparator)	Given a Collection of Map.Entry instances, returns a SortedMap representing it that is immutable.
static final <K, V> SortedMap<K,V>	immutableSortedMapOf(Map<? extends K,? extends V> map)	Given a Map, returns a SortedMap representing it that is immutable.
static final <K, V> SortedMap<K,V>	immutableSortedMapOf(Map<? extends K,? extends V> map, Comparator<? super K> comparator)	Given a Map or a SortedMap, returns a SortedMap representing it that is immutable.
static final <E> SortedSet<E>	immutableSortedSetOf(Collection<? extends E> set)	Given a Collection, returns a SortedSet representing it that is immutable.
static final <E> SortedSet<E>	immutableSortedSetOf(Collection<? extends E> set, Comparator<? super E> comparator)	Given a Collection, returns a SortedSet representing it that is immutable.

Methods inherited from class java.lang.Object

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

Method Details

findStaticSetterCallSite

public static final ConstantCallSite findStaticSetterCallSite(MethodHandles.Lookup lookup,
 String fieldName,
 MethodType methodType,
 Class<?> targetClass)
                                                       throws Throwable

Returns a ConstantCallSite backed by a static setter MethodHandle.

Parameters:

lookup - a MethodHandles.Lookup; will not be null

fieldName - the name of the static field to find; will not be null

methodType - a MethodType; will not be null

targetClass - the Class whose static field will be sought; will not be null

Returns:

a ConstantCallSite backed by a static setter MethodHandle

Throws:

Throwable - if an error occurs

See Also:

• MethodHandles.Lookup.findStaticSetter(Class, String, Class)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

findStaticCallSiteAsSpreader

public static final ConstantCallSite findStaticCallSiteAsSpreader(MethodHandles.Lookup lookup,
 String methodName,
 MethodType methodType,
 Class<?> targetClass)
                                                           throws Throwable

Returns a ConstantCallSite backed by a static MethodHandle adapted to be an array-spreading MethodHandle.

Parameters:

lookup - a MethodHandles.Lookup; will not be null

methodName - the name of the static field to find; will not be null

methodType - a MethodType; will not be null

targetClass - the Class whose static method will be sought; will not be null

Returns:

a ConstantCallSite backed by a static MethodHandle adapted to be an array-spreading MethodHandle

Throws:

Throwable - if an error occurs

See Also:

• MethodHandles.Lookup.findStatic(Class, String, MethodType)
• MethodHandle.asSpreader(Class, int)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

findSetterCallSite

public static final ConstantCallSite findSetterCallSite(MethodHandles.Lookup lookup,
 String fieldName,
 MethodType methodType,
 Class<?> targetClass)
                                                 throws Throwable

Returns a ConstantCallSite backed by a setter MethodHandle.

Parameters:

lookup - a MethodHandles.Lookup; will not be null

fieldName - the name of the field to find; will not be null

methodType - a MethodType; will not be null

targetClass - the Class whose instance field will be sought; will not be null

Returns:

a ConstantCallSite backed by a setter MethodHandle

Throws:

Throwable - if an error occurs

See Also:

• MethodHandles.Lookup.findSetter(Class, String, Class)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

findVirtualCallSite

public static final ConstantCallSite findVirtualCallSite(MethodHandles.Lookup lookup,
 String methodName,
 MethodType methodType,
 Class<?> targetClass)
                                                  throws Throwable

Returns a ConstantCallSite backed by a virtual MethodHandle.

Parameters:

lookup - a MethodHandles.Lookup; will not be null

methodName - the name of the method to find; will not be null

methodType - a MethodType; will not be null

targetClass - the Class whose virtual method will be sought; will not be null

Returns:

a ConstantCallSite backed by a virtual MethodHandle

Throws:

Throwable - if an error occurs

See Also:

• MethodHandles.Lookup.findVirtual(Class, String, MethodType)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

findConstructorCallSite

public static final ConstantCallSite findConstructorCallSite(MethodHandles.Lookup lookup,
 String ignoredMethodName,
 MethodType methodType,
 Class<?> targetClass)
                                                      throws Throwable

Returns a ConstantCallSite backed by a constructor MethodHandle.

Parameters:

lookup - a MethodHandles.Lookup; will not be null

ignoredMethodName - ignored

methodType - a MethodType; will not be null

targetClass - the Class whose constructor will be sought; will not be null

Returns:

a ConstantCallSite backed by a constructor MethodHandle

Throws:

Throwable - if an error occurs

See Also:

• MethodHandles.Lookup.findConstructor(Class, MethodType)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableEmptySortedMap

public static final <K,
V> SortedMap<K,V> immutableEmptySortedMap(Comparator<? super K> comparator)

Returns an empty, immutable SortedMap.

Type Parameters:

K - the type borne by the supplied Map's keys

V - the type borne by the supplied Map's values

Parameters:

comparator - the Comparator to be returned by the returned SortedMap's SortedMap.comparator() method; may be null

Returns:

an immutable, empty SortedMap

Throws:

NullPointerException - if map is null

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableSortedMapOf

public static final <K,
V> SortedMap<K,V> immutableSortedMapOf(Collection<? extends Map.Entry<K,V>> entries)

Given a Collection of Map.Entry instances, returns a SortedMap representing it that is immutable.

Type Parameters:

K - the type borne by the supplied entries' keys

V - the type borne by the supplied entries' values

Parameters:

entries - the Map.Entry instances to represent; must not be null

Returns:

an immutable SortedMap representing the supplied entries

Throws:

NullPointerException - if entries is null

See Also:

• immutableSortedMapOf(Collection, Comparator)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableSortedMapOf

public static final <K,
V> SortedMap<K,V> immutableSortedMapOf(Collection<? extends Map.Entry<K,V>> entries,
 Comparator<? super K> comparator)

Given a Collection of Map.Entry instances, returns a SortedMap representing it that is immutable.

Type Parameters:

K - the type borne by the supplied entries' keys

V - the type borne by the supplied entries' values

Parameters:

entries - the Map.Entry instances to represent; must not be null

comparator - the Comparator to use to order the returned SortedMap's elements; may be null to indicate natural order should be used in which case the supplied keys and values must implement Comparable

Returns:

an immutable SortedMap representing the supplied entries

Throws:

NullPointerException - if entries is null

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableSortedMapOf

public static final <K,
V> SortedMap<K,V> immutableSortedMapOf(Map<? extends K,? extends V> map)

Given a Map, returns a SortedMap representing it that is immutable.

Type Parameters:

K - the type borne by the supplied Map's keys

V - the type borne by the supplied Map's values

Parameters:

map - the Map to represent; must not be null

Returns:

an immutable SortedMap representing the supplied Map

Throws:

NullPointerException - if map is null

See Also:

• immutableSortedMapOf(Map, Comparator)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableSortedMapOf

public static final <K,
V> SortedMap<K,V> immutableSortedMapOf(Map<? extends K,? extends V> map,
 Comparator<? super K> comparator)

Given a Map or a SortedMap, returns a SortedMap representing it that is immutable.

Type Parameters:

K - the type borne by the supplied Map's keys

V - the type borne by the supplied Map's values

Parameters:

map - the Map to represent; must not be null

comparator - the Comparator to use to order the supplied Map's elements; may be null to indicate natural order should be used in which case the supplied Map's elements must implement Comparable

Returns:

an immutable SortedMap representing the supplied Map

Throws:

NullPointerException - if map is null

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableEmptySortedSet

public static final <E> SortedSet<E> immutableEmptySortedSet(Comparator<? super E> comparator)

Returns an immutable, empty SortedSet.

Type Parameters:

E - the SortedSet's element type

Parameters:

comparator - the Comparator to be returned by the returned SortedSet's SortedSet.comparator() method; may be null

Returns:

an immutable, empty SortedSet

Throws:

NullPointerException - if set is null

See Also:

• immutableSortedSetOf(Collection, Comparator)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableSortedSetOf

public static final <E> SortedSet<E> immutableSortedSetOf(Collection<? extends E> set)

Given a Collection, returns a SortedSet representing it that is immutable.

Type Parameters:

E - the type borne by the supplied Collection's elements

Parameters:

set - the Collection to represent; must not be null

Returns:

an immutable SortedSet representing the supplied Collection

Throws:

NullPointerException - if set is null

See Also:

• immutableSortedSetOf(Collection, Comparator)

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.

immutableSortedSetOf

public static final <E> SortedSet<E> immutableSortedSetOf(Collection<? extends E> set,
 Comparator<? super E> comparator)

Given a Collection, returns a SortedSet representing it that is immutable.

Type Parameters:

E - the type borne by the supplied Collection's elements

Parameters:

set - the Collection to represent; must not be null

comparator - the Comparator to use to order the supplied Collection's elements; may be null to indicate natural order should be used in which case the supplied Collection's elements must implement Comparable

Returns:

an immutable SortedSet representing the supplied Collection

Throws:

NullPointerException - if set is null

Idempotency:

This method is idempotent and deterministic.

Nullability:

This method never returns null.

Thread Safety:

This method is safe for concurrent use by multiple threads.