uk.co.strangeskies.reflection

Class AnnotatedTypeSubstitution

java.lang.Object

uk.co.strangeskies.reflection.AnnotatedTypeSubstitution

public class AnnotatedTypeSubstitution
extends java.lang.Object

TODO update the javadocs to take about ANNOTATED types... A TypeSubstitution object is a function mapping Type to Type, which recursively visits each type mentioned by a given type and applies a substitution to those it encounters which match a given condition.

Constructor Summary

Constructors

Constructor and Description
AnnotatedTypeSubstitution() Create a new TypeSubstitution with no initial substitution rules.
AnnotatedTypeSubstitution(java.util.function.Function<? super java.lang.reflect.AnnotatedType,? extends java.lang.reflect.AnnotatedType> mapping) Create a new TypeSubstitution to apply the given mapping function.
AnnotatedTypeSubstitution(java.util.Map<?,? extends java.lang.reflect.AnnotatedType> mapping) Create a new TypeSubstitution to apply the given mapping.

Method Summary

Modifier and Type	Method and Description
java.lang.reflect.AnnotatedType	resolve(java.lang.reflect.AnnotatedType type) Resolve the result of this substitution as applied to the given type.
java.lang.reflect.AnnotatedType	resolve(java.lang.reflect.AnnotatedType type, Isomorphism isomorphism) Resolve the result of this substitution as applied to the given type.
protected java.lang.reflect.AnnotatedType	resolve(java.lang.reflect.AnnotatedType type, Isomorphism isomorphism, IdentityProperty<java.lang.Boolean> changed)
AnnotatedTypeSubstitution	where(java.lang.reflect.AnnotatedType from, java.lang.reflect.AnnotatedType to) Create a new TypeSubstitution by adding a specific single substitution rule to the receiver of the invocation.
AnnotatedTypeSubstitution	where(java.util.function.Predicate<? super java.lang.reflect.AnnotatedType> from, java.util.function.Function<? super java.lang.reflect.AnnotatedType,? extends java.lang.reflect.AnnotatedType> to) Create a new TypeSubstitution by adding a specific single substitution rule to the receiver of the invocation.
AnnotatedTypeSubstitution	withTypeVariables() Create a new TypeSubstitution which is the same as the receiver with the additional behavior that type variables are also included for bounds substitution.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedTypeSubstitution

public AnnotatedTypeSubstitution()

Create a new TypeSubstitution with no initial substitution rules.

AnnotatedTypeSubstitution

public AnnotatedTypeSubstitution(java.util.function.Function<? super java.lang.reflect.AnnotatedType,? extends java.lang.reflect.AnnotatedType> mapping)

Create a new TypeSubstitution to apply the given mapping function. Typically we do something like create an instance from a Map of Type instances to other Type instances, then pass the method reference of Map.get(Object) for that map to this constructor. For this specific example use case though, AnnotatedTypeSubstitution(Map) would perform slightly better.

Parameters:

mapping - A mapping function for transforming encountered types to their substitution types.

AnnotatedTypeSubstitution

public AnnotatedTypeSubstitution(java.util.Map<?,? extends java.lang.reflect.AnnotatedType> mapping)

Create a new TypeSubstitution to apply the given mapping. This is more efficient than the more general AnnotatedTypeSubstitution(Function) constructor, as it can skip type traversal for empty maps.

Parameters:

mapping - A mapping function for transforming encountered types to their substitution types.

Method Detail

where

public AnnotatedTypeSubstitution where(java.lang.reflect.AnnotatedType from,
                                       java.lang.reflect.AnnotatedType to)

Create a new TypeSubstitution by adding a specific single substitution rule to the receiver of the invocation. The new rule will be checked and applied before any existing rules. The receiving TypeSubstitution of invocation of this method will remain unchanged.

Parameters:

from - The type to match in application of this rule.

to - The type to substitute for types which match the rule.

Returns:

A new TypeSubstitution object with the rule added.

where

public AnnotatedTypeSubstitution where(java.util.function.Predicate<? super java.lang.reflect.AnnotatedType> from,
                                       java.util.function.Function<? super java.lang.reflect.AnnotatedType,? extends java.lang.reflect.AnnotatedType> to)

Create a new TypeSubstitution by adding a specific single substitution rule to the receiver of the invocation. The new rule will be checked and applied before any existing rules. The receiving TypeSubstitution of invocation of this method will remain unchanged.

Parameters:

from - The type matching condition of the new rule.

to - The substitution transformation to apply to types matching the given condition.

Returns:

A new TypeSubstitution object with the rule added.

withTypeVariables

public AnnotatedTypeSubstitution withTypeVariables()

Create a new TypeSubstitution which is the same as the receiver with the additional behavior that type variables are also included for bounds substitution. Normally it makes sense to exclude type variable bounds for substitution, as their type is immutable and baked into their defining class definition, but sometimes we may still want this behavior.

Returns:

A new TypeSubstitution object with the rule added.

resolve

public java.lang.reflect.AnnotatedType resolve(java.lang.reflect.AnnotatedType type)

Resolve the result of this substitution as applied to the given type.

Parameters:

type - The type for which we want to make a substitution.

Returns:

The result of application of this substitution. The result is not guaranteed to be well formed with respect to bounds.

resolve

public java.lang.reflect.AnnotatedType resolve(java.lang.reflect.AnnotatedType type,
                                               Isomorphism isomorphism)

Resolve the result of this substitution as applied to the given type.

Parameters:

type - The type for which we want to make a substitution.

isomorphism - the isomorphism for dealing with self bounded and infinite types

Returns:

The result of application of this substitution. The result is not guaranteed to be well formed with respect to bounds.

resolve

protected java.lang.reflect.AnnotatedType resolve(java.lang.reflect.AnnotatedType type,
                                                  Isomorphism isomorphism,
                                                  IdentityProperty<java.lang.Boolean> changed)