uk.co.strangeskies.reflection.token

Interface MemberToken<T,S extends MemberToken<T,S>>

Type Parameters:

T - the owner type of the member

S - the type of member token

All Superinterfaces:

DeclarationToken<S>

All Known Implementing Classes:

ExecutableToken, FieldToken

public interface MemberToken<T,S extends MemberToken<T,S>>
extends DeclarationToken<S>

A type safe wrapper around Member instances, with proper handling of members on generic classes.

type members may be created over types which mention inference variables, or even over inference variables themselves.

Method Summary

Modifier and Type	Method and Description
BoundSet	getBounds()
default java.lang.Class<?>	getDeclaringClass()
java.lang.reflect.Member	getMember()
java.lang.String	getName()
TypeToken<? super T>	getReceiverType() This is the exact receiver type which this member should be accessed from or invoked upon.
default Visibility	getVisibility() Determine the visibility of the member
default boolean	isFinal()
default boolean	isRaw()
default boolean	isStatic()
S	resolve() Derived a new MemberToken instance with all associated generic parameters inferred.
S	withBounds(BoundSet bounds) Derive a new MemberToken instance, with the given bounds incorporated into the bounds of the underlying resolver.
MemberToken<?,?>	withReceiverType(java.lang.reflect.Type type) As @see withReceiverType(TypeToken).
<U> MemberToken<U,?>	withReceiverType(TypeToken<U> type) Derive a new instance of MemberToken with the given owner type.

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

getAllTypeArguments, getAllTypeParameterCount, getAllTypeParameters, getOwningDeclaration, getTypeArguments, getTypeParameterCount, getTypeParameters, isGeneric, resolveTypeArgument, resolveTypeArgument, withAllTypeArguments, withAllTypeArguments, withTypeArguments, withTypeArguments, withTypeArguments, withTypeArguments

Method Detail

getName

java.lang.String getName()

Returns:

the name of the member

getMember

java.lang.reflect.Member getMember()

Returns:

the actual Member object backing the MemberToken.

getBounds

BoundSet getBounds()

Returns:

the inference bounds involved in this MemberToken

isStatic

default boolean isStatic()

Returns:

true if the wrapped member is static, false otherwise

isFinal

default boolean isFinal()

Returns:

true if the wrapped member is final, false otherwise

getVisibility

default Visibility getVisibility()

Determine the visibility of the member

Returns:

a Visibility object describing the member

getDeclaringClass

default java.lang.Class<?> getDeclaringClass()

Returns:

The exact declaring class of this member.

getReceiverType

TypeToken<? super T> getReceiverType()

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.

Returns:

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

withBounds

S withBounds(BoundSet bounds)

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

Parameters:

bounds - the new bounds to incorporate

Returns:

the newly derived MemberToken

withReceiverType

<U> MemberToken<U,?> withReceiverType(TypeToken<U> type)

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.

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.

withReceiverType

MemberToken<?,?> withReceiverType(java.lang.reflect.Type type)

As @see withReceiverType(TypeToken).

resolve

S resolve()

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

Returns:

the derived MemberToken with inferred types

isRaw

default boolean isRaw()

Specified by:

isRaw in interface DeclarationToken<S extends MemberToken<T,S>>

Returns:

true if the member is declared on a raw type, false otherwise