Package org.kiwiproject.beta.base

Class KiwiCasts2

java.lang.Object

org.kiwiproject.beta.base.KiwiCasts2

@Beta
public final class KiwiCasts2
extends Object

Utilities related to casting.

Some of these methods may be moved into org.kiwiproject.base.KiwiCasts in kiwi. As of this writing, KiwiCasts is not released in kiwi. It is scheduled for the 4.11.0 release. It was added to kiwi in this commit.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KiwiCasts2.CollectionCheckStrategy	Strategy interface for checking elements in a collection.
static class	KiwiCasts2.DefaultCollectionCheckStrategy	Default implementation of KiwiCasts2.CollectionCheckStrategy that uses DEFAULT_MAX_NON_NULL_CHECKS as the maximum non-null checks and checks only one (non-null) element in the collection.
static class	KiwiCasts2.DefaultListCheckStrategy	Default implementation of KiwiCasts2.ListCheckStrategy that uses DEFAULT_MAX_NON_NULL_CHECKS as the maximum non-null checks and checks only one (non-null) element in the list.
static class	KiwiCasts2.DefaultMapCheckStrategy	Default implementation of KiwiCasts2.MapCheckStrategy that uses DEFAULT_MAX_NON_NULL_CHECKS as the maximum non-null checks and checks only one (non-null) entry in the map.
static class	KiwiCasts2.DefaultSetCheckStrategy	Default implementation of KiwiCasts2.SetCheckStrategy that uses DEFAULT_MAX_NON_NULL_CHECKS as the maximum non-null checks and checks only one (non-null) element in the set.
static interface	KiwiCasts2.ListCheckStrategy	Strategy interface for checking elements in a list.
static interface	KiwiCasts2.MapCheckStrategy	Strategy interface for checking entries in a map.
static interface	KiwiCasts2.SetCheckStrategy	Strategy interface for checking elements in a set.
static class	KiwiCasts2.StandardCollectionCheckStrategy	Standard implementation of KiwiCasts2.CollectionCheckStrategy that allows configuring the number of non-null and type checks to perform.
static class	KiwiCasts2.StandardListCheckStrategy	Standard implementation of KiwiCasts2.ListCheckStrategy that allows configuring the number of non-null and type checks to perform.
static class	KiwiCasts2.StandardMapCheckStrategy	Standard implementation of KiwiCasts2.MapCheckStrategy that allows configuring the number of non-null and type checks to perform.
static class	KiwiCasts2.StandardSetCheckStrategy	Standard implementation of KiwiCasts2.SetCheckStrategy that allows configuring the number of non-null and type checks to perform.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_NON_NULL_CHECKS	The default maximum number of non-null checks to perform when checking elements in a collection.
static final int	DEFAULT_MAX_TYPE_CHECKS	The default maximum number of type checks to perform when checking elements in a collection.

Method Summary

Modifier and Type	Method	Description
static <T> Collection<T>	castToCollectionAndCheckElements(Class<T> expectedType, Object object)	Casts the given object to a Collection and checks that its elements are of the expected type.
static <T> Collection<T>	castToCollectionAndCheckElements(Class<T> expectedType, Object object, KiwiCasts2.CollectionCheckStrategy strategy)	Casts the given object to a Collection and checks that its elements are of the expected type using the specified strategy.
static <T> List<T>	castToListAndCheckElements(Class<T> expectedType, Object object)	Casts the given object to a List and checks that its elements are of the expected type.
static <T> List<T>	castToListAndCheckElements(Class<T> expectedType, Object object, KiwiCasts2.ListCheckStrategy strategy)	Casts the given object to a List and checks that its elements are of the expected type using the specified check strategy.
static <K, V> Map<K,V>	castToMapAndCheckEntries(Class<K> keyType, Class<V> valueType, Object object)	Casts the given object to a Map and checks that its keys and values are of the expected types.
static <K, V> Map<K,V>	castToMapAndCheckEntries(Class<K> keyType, Class<V> valueType, Object object, KiwiCasts2.MapCheckStrategy strategy)	Casts the given object to a Map and checks that its keys and values are of the expected types using the specified check strategy.
static <T> Set<T>	castToSetAndCheckElements(Class<T> expectedType, Object object)	Casts the given object to a Set and checks that its elements are of the expected type.
static <T> Set<T>	castToSetAndCheckElements(Class<T> expectedType, Object object, KiwiCasts2.SetCheckStrategy strategy)	Casts the given object to a Set and checks that its elements are of the expected type using the specified check strategy.
static <T> T	uncheckedCast(Object object)	Performs an unchecked cast of the given object to the specified type.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_NON_NULL_CHECKS

public static final int DEFAULT_MAX_NON_NULL_CHECKS

The default maximum number of non-null checks to perform when checking elements in a collection.

See Also:

• Constant Field Values

DEFAULT_MAX_TYPE_CHECKS

public static final int DEFAULT_MAX_TYPE_CHECKS

The default maximum number of type checks to perform when checking elements in a collection.

See Also:

• Constant Field Values

Method Details

uncheckedCast

public static <T> T uncheckedCast(Object object)

Performs an unchecked cast of the given object to the specified type.

NOTE: This method is copied directly from KiwiCasts in kiwi, since it is not currently in a released version of kiwi, and because it is necessary here.

Type Parameters:

T - the type to cast to

Parameters:

object - the object to cast

Returns:

the object cast to the specified type

castToCollectionAndCheckElements

public static <T> Collection<T> castToCollectionAndCheckElements(Class<T> expectedType,
 Object object)

Casts the given object to a Collection and checks that its elements are of the expected type. Uses KiwiCasts2.DefaultCollectionCheckStrategy as the collection check strategy.

Type Parameters:

T - the expected element type

Parameters:

expectedType - the expected type of elements in the collection

object - the object to cast to a Collection

Returns:

the object cast to a Collection with elements of the expected type

Throws:

TypeMismatchException - if the object is not a Collection or contains elements of incompatible types

castToCollectionAndCheckElements

public static <T> Collection<T> castToCollectionAndCheckElements(Class<T> expectedType,
 Object object,
 KiwiCasts2.CollectionCheckStrategy strategy)

Casts the given object to a Collection and checks that its elements are of the expected type using the specified strategy.

Type Parameters:

T - the expected element type

Parameters:

expectedType - the expected type of elements in the collection

object - the object to cast to a Collection

strategy - the strategy to use for checking elements

Returns:

the object cast to a Collection with elements of the expected type

Throws:

TypeMismatchException - if the object is not a Collection or contains elements of incompatible types

castToListAndCheckElements

public static <T> List<T> castToListAndCheckElements(Class<T> expectedType,
 Object object)

Casts the given object to a List and checks that its elements are of the expected type. Uses KiwiCasts2.DefaultListCheckStrategy as the list check strategy.

Type Parameters:

T - the expected element type

Parameters:

expectedType - the expected type of elements in the list

object - the object to cast to a List

Returns:

the object cast to a List with elements of the expected type

Throws:

TypeMismatchException - if the object is not a List or contains elements of incompatible types

castToListAndCheckElements

public static <T> List<T> castToListAndCheckElements(Class<T> expectedType,
 Object object,
 KiwiCasts2.ListCheckStrategy strategy)

Casts the given object to a List and checks that its elements are of the expected type using the specified check strategy.

Type Parameters:

T - the expected element type

Parameters:

expectedType - the expected type of elements in the list

object - the object to cast to a List

strategy - the strategy to use for checking elements

Returns:

the object cast to a List with elements of the expected type

Throws:

TypeMismatchException - if the object is not a List or contains elements of incompatible types

castToSetAndCheckElements

public static <T> Set<T> castToSetAndCheckElements(Class<T> expectedType,
 Object object)

Casts the given object to a Set and checks that its elements are of the expected type. Uses KiwiCasts2.DefaultSetCheckStrategy as the set check strategy.

Type Parameters:

T - the expected element type

Parameters:

expectedType - the expected type of elements in the set

object - the object to cast to a Set

Returns:

the object cast to a Set with elements of the expected type

Throws:

TypeMismatchException - if the object is not a Set or contains elements of incompatible types

castToSetAndCheckElements

public static <T> Set<T> castToSetAndCheckElements(Class<T> expectedType,
 Object object,
 KiwiCasts2.SetCheckStrategy strategy)

Casts the given object to a Set and checks that its elements are of the expected type using the specified check strategy.

Type Parameters:

T - the expected element type

Parameters:

expectedType - the expected type of elements in the set

object - the object to cast to a Set

strategy - the strategy to use for checking elements

Returns:

the object cast to a Set with elements of the expected type

Throws:

TypeMismatchException - if the object is not a Set or contains elements of incompatible types

castToMapAndCheckEntries

public static <K,
V> Map<K,V> castToMapAndCheckEntries(Class<K> keyType,
 Class<V> valueType,
 Object object)

Casts the given object to a Map and checks that its keys and values are of the expected types. Uses KiwiCasts2.DefaultMapCheckStrategy as the map check strategy.

Type Parameters:

K - the expected key type

V - the expected value type

Parameters:

keyType - the expected type of keys in the map

valueType - the expected type of values in the map

object - the object to cast to a Map

Returns:

the object cast to a Map with keys and values of the expected types

Throws:

TypeMismatchException - if the object is not a Map or contains keys or values of incompatible types

castToMapAndCheckEntries

public static <K,
V> Map<K,V> castToMapAndCheckEntries(Class<K> keyType,
 Class<V> valueType,
 Object object,
 KiwiCasts2.MapCheckStrategy strategy)

Casts the given object to a Map and checks that its keys and values are of the expected types using the specified check strategy.

Type Parameters:

K - the expected key type

V - the expected value type

Parameters:

keyType - the expected type of keys in the map

valueType - the expected type of values in the map

object - the object to cast to a Map

strategy - the strategy to use for checking entries

Returns:

the object cast to a Map with keys and values of the expected types

Throws:

TypeMismatchException - if the object is not a Map or contains keys or values of incompatible types