uk.co.strangeskies.reflection.token

Class FieldToken<O,T>

java.lang.Object

uk.co.strangeskies.reflection.token.FieldToken<O,T>

Type Parameters:

O - the owner type which the field belongs to

T - the type of the field

All Implemented Interfaces:

DeclarationToken<FieldToken<O,T>>, MemberToken<O,FieldToken<O,T>>

public class FieldToken<O,T>
extends java.lang.Object
implements MemberToken<O,FieldToken<O,T>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldToken(java.lang.Class<?> instance, java.lang.reflect.Field field)

Method Summary

Modifier and Type	Method and Description
static FieldToken<java.lang.Void,?>	forField(java.lang.reflect.Field field) Create a new FieldToken instance from a reference to a Field of an outer or static class.
static FieldToken<java.lang.Void,?>	forStaticField(java.lang.reflect.Field field) Create a new FieldToken instance from a reference to a Field.
T	get(O target)
BoundSet	getBounds()
TypeToken<T>	getFieldType()
java.lang.reflect.Field	getMember()
java.lang.String	getName()
java.util.Optional<? extends DeclarationToken<?>>	getOwningDeclaration()
TypeToken<? super O>	getReceiverType() This is the exact receiver type which this member should be accessed from or invoked upon.
java.util.stream.Stream<TypeArgument<?>>	getTypeArguments()
int	getTypeParameterCount()
java.util.stream.Stream<TypeParameter<?>>	getTypeParameters()
boolean	isGeneric()
boolean	isTransient()
boolean	isVolatile()
FieldToken<? extends O,? extends T>	parameterize() If the declaration is raw, parameterize it with its own type parameters, otherwise return the declaration itself.
FieldToken<O,T>	resolve() Derived a new MemberToken instance with all associated generic parameters inferred.
void	set(O target, T value)
static java.util.stream.Stream<FieldToken<java.lang.Void,?>>	staticFields(java.lang.Class<?> declaringClass) Find which fields are declared on this type.
FieldToken<O,T>	withAllTypeArguments(java.util.List<java.lang.reflect.Type> typeArguments) Derive a new DeclarationToken instance with the given type argument parameterization.
FieldToken<O,T>	withAllTypeArguments(java.lang.reflect.Type... typeArguments)
<S> FieldToken<O,? super S>	withAssignmentFrom(java.lang.Class<S> target) As @see withAssignmentFrom(TypeToken).
FieldToken<O,?>	withAssignmentFrom(java.lang.reflect.Type target) As @see withAssignmentFrom(TypeToken).
<S> FieldToken<O,? super S>	withAssignmentFrom(TypeToken<S> target) Derive a new instance of FieldToken which is assignment compatible from the given type.
<S> FieldToken<O,? extends S>	withAssignmentTo(java.lang.Class<S> target) As @see withAssignmentTo(TypeToken).
FieldToken<O,?>	withAssignmentTo(java.lang.reflect.Type target) As @see withAssignmentTo(TypeToken).
<S> FieldToken<O,? extends S>	withAssignmentTo(TypeToken<S> target) Derive a new instance of FieldToken with the given assignment target type.
FieldToken<O,T>	withBounds(BoundSet bounds) Derive a new FieldToken instance, with the given bounds incorporated into the bounds of the underlying resolver.
FieldToken<?,? extends T>	withReceiverType(java.lang.reflect.Type type) As @see MemberToken.withReceiverType(TypeToken).
<U> FieldToken<U,? extends T>	withReceiverType(TypeToken<U> type) Derive a new instance of MemberToken with the given owner type.
<S> FieldToken<O,S>	withType(java.lang.Class<S> target) As @see withType(TypeToken).
FieldToken<O,?>	withType(java.lang.reflect.Type target) As @see withType(TypeToken).
<S> FieldToken<O,S>	withType(TypeToken<S> target) Derive a new instance of FieldToken with the exact given type.
FieldToken<O,T>	withTypeArguments(java.util.Collection<? extends TypeArgument<?>> arguments) Derive a new ExecutableToken instance from this, with types substituted according to the given arguments.
FieldToken<O,T>	withTypeArguments(java.util.List<java.lang.reflect.Type> typeArguments) As @see DeclarationToken.withAllTypeArguments(List), but only providing arguments for the parameters occurring directly on the declaration.
FieldToken<O,T>	withTypeArguments(java.lang.reflect.Type... typeArguments)
protected FieldToken<O,T>	withTypeSubstitution(BoundSet bounds, TypeSubstitution typeSubstitution)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.co.strangeskies.reflection.token.MemberToken

getDeclaringClass, getVisibility, isFinal, isRaw, isStatic

Methods inherited from interface uk.co.strangeskies.reflection.token.DeclarationToken

getAllTypeArguments, getAllTypeParameterCount, getAllTypeParameters, resolveTypeArgument, resolveTypeArgument, withTypeArguments

Constructor Detail

FieldToken

protected FieldToken(java.lang.Class<?> instance,
                     java.lang.reflect.Field field)

Method Detail

forField

public static FieldToken<java.lang.Void,?> forField(java.lang.reflect.Field field)

Create a new FieldToken instance from a reference to a Field of an outer or static class.

If the method is generic it will be parameterized with its own type variables.

Parameters:

field - the field to wrap

Returns:

an field member wrapping the given constructor

forStaticField

public static FieldToken<java.lang.Void,?> forStaticField(java.lang.reflect.Field field)

Create a new FieldToken instance from a reference to a Field.

Parameters:

field - the field to wrap

Returns:

a field member wrapping the given field

getName

public java.lang.String getName()

Specified by:

getName in interface MemberToken<O,FieldToken<O,T>>

Returns:

the name of the member

getMember

public java.lang.reflect.Field getMember()

Specified by:

getMember in interface MemberToken<O,FieldToken<O,T>>

Returns:

the actual Member object backing the MemberToken.

getBounds

public BoundSet getBounds()

Specified by:

getBounds in interface MemberToken<O,FieldToken<O,T>>

Returns:

the inference bounds involved in this MemberToken

isVolatile

public boolean isVolatile()

Returns:

true if the wrapped field is volatile, false otherwise

isTransient

public boolean isTransient()

Returns:

true if the wrapped field is transient, false otherwise

getReceiverType

public TypeToken<? super O> getReceiverType()

Description copied from interface: MemberToken

This is the exact receiver type which this member should be accessed from or invoked upon.

For non-static members, this type will be identical to the owning type.

For constructors and static members, if they are declared on a non-static inner class then the receiver type should be a subtype of the enclosing class, otherwise the receiver type should be void.

Specified by:

getReceiverType in interface MemberToken<O,FieldToken<O,T>>

Returns:

a type token over the receiver type for invocation or field access, or over void.class if the member has no receiver type

getFieldType

public TypeToken<T> getFieldType()

Returns:

the exact generic type of the field according to the type of its owner

parameterize

public FieldToken<? extends O,? extends T> parameterize()

If the declaration is raw, parameterize it with its own type parameters, otherwise return the declaration itself.

Returns:

the parameterized version of the declaration where applicable, else the unmodified declaration

withBounds

public FieldToken<O,T> withBounds(BoundSet bounds)

Derive a new FieldToken instance, with the given bounds incorporated into the bounds of the underlying resolver. The original FieldToken will remain unmodified.

Specified by:

withBounds in interface MemberToken<O,FieldToken<O,T>>

Parameters:

bounds - The new bounds to incorporate.

Returns:

The newly derived ExecutableToken.

withTypeSubstitution

protected FieldToken<O,T> withTypeSubstitution(BoundSet bounds,
                                               TypeSubstitution typeSubstitution)

withReceiverType

public FieldToken<?,? extends T> withReceiverType(java.lang.reflect.Type type)

Description copied from interface: MemberToken

As @see MemberToken.withReceiverType(TypeToken).

Specified by:

withReceiverType in interface MemberToken<O,FieldToken<O,T>>

withReceiverType

public <U> FieldToken<U,? extends T> withReceiverType(TypeToken<U> type)

Description copied from interface: MemberToken

Derive a new instance of MemberToken with the given owner type.

The new MemberToken will always have a owner type which is as or more specific than both the current receiver type and the given type. This means that the new owner will be assignment compatible with the given type, but if the given type contains wildcards or inference variables which are less specific that those implied by the current receiver type, new type arguments will be inferred in their place, or further bounds may be added to them.

If the receiver type is not generic, the method will always return the same token, or will throw an exception if the given type is not a subtype of the receiver.

This may result in unsafe transformations when we convert from a raw receiver to a parameterized receiver, but declarations of those types should give a raw type warning from the Java compiler and this is considered sufficient.

Specified by:

withReceiverType in interface MemberToken<O,FieldToken<O,T>>

Parameters:

type - The new owner type. The raw type of this type must be a subtype of the raw type of the current receiver type.

Returns:

A new MemberToken compatible with the given owner type.

The new owner type will not be effectively more specific than the intersection type of the current owner type and the given type. That is, any type which can be assigned to both the given type and the current owner type, will also be assignable to the new type.

withType

public <S> FieldToken<O,S> withType(java.lang.Class<S> target)

As @see withType(TypeToken).

withType

public FieldToken<O,?> withType(java.lang.reflect.Type target)

As @see withType(TypeToken).

withType

public <S> FieldToken<O,S> withType(TypeToken<S> target)

Derive a new instance of FieldToken with the exact given type. TODO document

withAssignmentTo

public <S> FieldToken<O,? extends S> withAssignmentTo(java.lang.Class<S> target)

As @see withAssignmentTo(TypeToken).

withAssignmentTo

public FieldToken<O,?> withAssignmentTo(java.lang.reflect.Type target)

As @see withAssignmentTo(TypeToken).

withAssignmentTo

public <S> FieldToken<O,? extends S> withAssignmentTo(TypeToken<S> target)

Derive a new instance of FieldToken with the given assignment target type. TODO document

withAssignmentFrom

public <S> FieldToken<O,? super S> withAssignmentFrom(java.lang.Class<S> target)

As @see withAssignmentFrom(TypeToken).

withAssignmentFrom

public FieldToken<O,?> withAssignmentFrom(java.lang.reflect.Type target)

As @see withAssignmentFrom(TypeToken).

withAssignmentFrom

public <S> FieldToken<O,? super S> withAssignmentFrom(TypeToken<S> target)

Derive a new instance of FieldToken which is assignment compatible from the given type. TODO document

resolve

public FieldToken<O,T> resolve()

Description copied from interface: MemberToken

Derived a new MemberToken instance with all associated generic parameters inferred.

Specified by:

resolve in interface MemberToken<O,FieldToken<O,T>>

Returns:

the derived MemberToken with inferred types

get

public T get(O target)

Parameters:

target - the instance to access the field of

Returns:

the value of the field

set

public void set(O target,
                T value)

Parameters:

target - the instance to assign to the field of

value - the value to assign

getOwningDeclaration

public java.util.Optional<? extends DeclarationToken<?>> getOwningDeclaration()

Specified by:

getOwningDeclaration in interface DeclarationToken<FieldToken<O,T>>

Returns:

the declaration directly enclosing this declaration

getTypeParameterCount

public int getTypeParameterCount()

Specified by:

getTypeParameterCount in interface DeclarationToken<FieldToken<O,T>>

Returns:

the count of the generic type parameters of the declaration.

getTypeParameters

public java.util.stream.Stream<TypeParameter<?>> getTypeParameters()

Specified by:

getTypeParameters in interface DeclarationToken<FieldToken<O,T>>

Returns:

The generic type parameter instantiations of the wrapped Executable, or their inference variables if not yet instantiated.

getTypeArguments

public java.util.stream.Stream<TypeArgument<?>> getTypeArguments()

Specified by:

getTypeArguments in interface DeclarationToken<FieldToken<O,T>>

Returns:

The generic type parameter instantiations of the wrapped Executable, or their inference variables if not yet instantiated.

withTypeArguments

public FieldToken<O,T> withTypeArguments(java.util.Collection<? extends TypeArgument<?>> arguments)

Description copied from interface: DeclarationToken

Derive a new ExecutableToken instance from this, with types substituted according to the given arguments.

More specifically, each of the given arguments represents a type variable and an instantiation for that type variable. Occurrences of those type variables in the declaration will be substituted for their instantiations in the derived declaration.

The substitution will only succeed if it results in a valid parameterization of the declaration.

For example, the following method could be used to derive instances of TypeToken over different parameterizations of List<?> at runtime.

 
 public TypeToken<List<T>> getListType(TypeToken<T> elementType)} {
   return new TypeToken<T>()} {}.withTypeArguments(new TypeParameter<T>() {}.as(elementType));
 }
 
 

Specified by:

withTypeArguments in interface DeclarationToken<FieldToken<O,T>>

Parameters:

arguments - the type variable instantiations

Returns:

a new derived ExecutableToken instance with the given instantiation substituted for the given type variable

isGeneric

public boolean isGeneric()

Specified by:

isGeneric in interface DeclarationToken<FieldToken<O,T>>

Returns:

true if the declaration is generic, false otherwise

withAllTypeArguments

public FieldToken<O,T> withAllTypeArguments(java.util.List<java.lang.reflect.Type> typeArguments)

Description copied from interface: DeclarationToken

Derive a new DeclarationToken instance with the given type argument parameterization.

The types in the given list correspond, in order, to the type parameters of this declaration. The current parameterization of the declaration is substituted for that given.

Each substitution will only succeed if it is compatible with the bounds on that type variable, and if it is more specific than the current argument, whether it is an InferenceVariable, a TypeVariableCapture, or another kind of Type.

This behavior is different from DeclarationToken.withTypeArguments(Collection), which performs a substitution for arbitrary type variables rather than re-instantiating every parameter on the declaration.

Specified by:

withAllTypeArguments in interface DeclarationToken<FieldToken<O,T>>

Parameters:

typeArguments - a list of arguments for each generic type parameter of the underlying declaration

Returns:

a new derived DeclarationToken instance with the given instantiations substituted for each generic type parameter, in order

withTypeArguments

public FieldToken<O,T> withTypeArguments(java.util.List<java.lang.reflect.Type> typeArguments)

Description copied from interface: DeclarationToken

As @see DeclarationToken.withAllTypeArguments(List), but only providing arguments for the parameters occurring directly on the declaration.

Specified by:

withTypeArguments in interface DeclarationToken<FieldToken<O,T>>

withAllTypeArguments

public FieldToken<O,T> withAllTypeArguments(java.lang.reflect.Type... typeArguments)

Specified by:

withAllTypeArguments in interface DeclarationToken<FieldToken<O,T>>

See Also:

DeclarationToken.withTypeArguments(List)

withTypeArguments

public FieldToken<O,T> withTypeArguments(java.lang.reflect.Type... typeArguments)

Specified by:

withTypeArguments in interface DeclarationToken<FieldToken<O,T>>

See Also:

DeclarationToken.withTypeArguments(List)

staticFields

public static java.util.stream.Stream<FieldToken<java.lang.Void,?>> staticFields(java.lang.Class<?> declaringClass)

Find which fields are declared on this type.

Parameters:

declaringClass - the declaring class for which to retrieve the fields

Returns:

all Field objects applicable to this type, wrapped in FieldToken instances