Top Description Inners Methods
net.bytebuddy.implementation.bind.annotation

public @Interface FieldGetterHandle

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:PARAMETER
Imports
net.bytebuddy.description.annotation.AnnotationDescription, net.bytebuddy.description.field.FieldDescription, net.bytebuddy.description.method.MethodDescription, .MethodList, .ParameterDescription, net.bytebuddy.description.type.TypeDefinition, .TypeDescription, .TypeList, net.bytebuddy.implementation.Implementation, net.bytebuddy.implementation.bind.MethodDelegationBinder, net.bytebuddy.implementation.bytecode.StackManipulation, net.bytebuddy.implementation.bytecode.assign.Assigner, net.bytebuddy.implementation.bytecode.member.MethodInvocation, .MethodVariableAccess, net.bytebuddy.utility.JavaConstant, .JavaType, net.bytebuddy.jar.asm.Opcodes, java.lang.annotation.*

Assigns a java.lang.invoke.MethodHandle to the annotated parameter which represents a getter of the represented field. For a binding to be valid, the instrumented type must be able to access a field of the given name.

Setting FieldGetterHandle#value() is optional. If the value is not set, the field value attempts to bind a setter's or getter's field if the intercepted method is an accessor method. Otherwise, the binding renders the target method to be an illegal candidate for binding.

Important Note

Don't confuse this annotation with net.bytebuddy.asm.Advice.FieldGetterHandle or net.bytebuddy.asm.MemberSubstitution.FieldSetterHandle. This annotation should be used with net.bytebuddy.implementation.MethodDelegation only.

See Also
net.bytebuddy.implementation.MethodDelegation, TargetMethodAnnotationDrivenBinder, RuntimeType

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
FieldGetterHandle.Binder

Binds a FieldGetterHandle annotation.

Method Summary

Modifier and TypeMethod and Description
public Class<?>

Returns:

The type that declares the accessed field.
declaringType()

Defines the type on which the field is declared.

public String

Returns:

The name of the field.
value()

The name of the field to be accessed.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

declaringTypeback to summary
public Class<?> declaringType()

Defines the type on which the field is declared. If this value is not set, the most specific type's field is read, if two fields with the same name exist in the same type hierarchy.

Returns:Class<?>

The type that declares the accessed field.

valueback to summary
public String value()

The name of the field to be accessed.

Returns:String

The name of the field.

net.bytebuddy.implementation.bind.annotation back to summary

public final Enum FieldGetterHandle.Binder

extends Enum<FieldGetterHandle.Binder>
implements TargetMethodAnnotationDrivenBinder.ParameterBinder<FieldGetterHandle>
Class Inheritance
All Implemented Interfaces
net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder
Binds a FieldGetterHandle annotation.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class
FieldGetterHandle.Binder.Delegate

A delegate implementation for the FieldGetterHandle.Binder.

Field Summary

Modifier and TypeField and Description
private static final MethodDescription.InDefinedShape
DECLARING_TYPE

The annotation method that for the defining type.

private final TargetMethodAnnotationDrivenBinder.ParameterBinder<FieldGetterHandle>
delegate

A delegate parameter binder responsible for binding the parameter.

private static final MethodDescription.InDefinedShape
FIELD_NAME

The annotation method for the field's name.

public static final FieldGetterHandle.Binder
INSTANCE

The singleton instance.

Constructor Summary

AccessConstructor and Description
private
Binder(TargetMethodAnnotationDrivenBinder.ParameterBinder<FieldGetterHandle>
A delegate parameter binder responsible for binding the parameter.
delegate)

Creates a new binder for a FieldGetterHandle.

Method Summary

Modifier and TypeMethod and Description
public MethodDelegationBinder.ParameterBinding<?>
bind(AnnotationDescription.Loadable<FieldGetterHandle>
The annotation that was cause for the delegation to this argument binder.
annotation, MethodDescription
The intercepted source method.
source, ParameterDescription
Tge target parameter that is subject to be bound to intercepting the source method.
target, Implementation.Target
The target of the current implementation that is subject to this binding.
implementationTarget, Assigner
An assigner that can be used for applying the binding.
assigner, Assigner.Typing
The typing to apply.
typing)

Implements net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.bind.

Creates a parameter binding for the given target parameter.
public Class<FieldGetterHandle>
getHandledType()

Implements net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.getHandledType.

The annotation type that is handled by this parameter binder.
public static FieldGetterHandle.Binder
valueOf(String name)

public static FieldGetterHandle.Binder[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DECLARING_TYPEback to summary
private static final MethodDescription.InDefinedShape DECLARING_TYPE

The annotation method that for the defining type.

delegateback to summary
private final TargetMethodAnnotationDrivenBinder.ParameterBinder<FieldGetterHandle> delegate

A delegate parameter binder responsible for binding the parameter.

FIELD_NAMEback to summary
private static final MethodDescription.InDefinedShape FIELD_NAME

The annotation method for the field's name.

INSTANCEback to summary
public static final FieldGetterHandle.Binder INSTANCE

The singleton instance.

Constructor Detail

Binderback to summary
private Binder(TargetMethodAnnotationDrivenBinder.ParameterBinder<FieldGetterHandle> delegate)

Creates a new binder for a FieldGetterHandle.

Parameters
delegate:TargetMethodAnnotationDrivenBinder.ParameterBinder<FieldGetterHandle>

A delegate parameter binder responsible for binding the parameter.

Method Detail

bindback to summary
public MethodDelegationBinder.ParameterBinding<?> bind(AnnotationDescription.Loadable<FieldGetterHandle> annotation, MethodDescription source, ParameterDescription target, Implementation.Target implementationTarget, Assigner assigner, Assigner.Typing typing)

Implements net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.bind.

Doc from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.bind.

Creates a parameter binding for the given target parameter.

Parameters
annotation:AnnotationDescription.Loadable<FieldGetterHandle>

The annotation that was cause for the delegation to this argument binder.

source:MethodDescription

The intercepted source method.

target:ParameterDescription

Tge target parameter that is subject to be bound to intercepting the source method.

implementationTarget:Implementation.Target

The target of the current implementation that is subject to this binding.

assigner:Assigner

An assigner that can be used for applying the binding.

typing:Assigner.Typing

The typing to apply.

Returns:MethodDelegationBinder.ParameterBinding<?>

A parameter binding for the requested target method parameter.

getHandledTypeback to summary
public Class<FieldGetterHandle> getHandledType()

Implements net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.getHandledType.

Doc from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.getHandledType.

The annotation type that is handled by this parameter binder.

Returns:Class<FieldGetterHandle>

The java.lang.annotation.Annotation#annotationType() handled by this parameter binder.

valueOfback to summary
public static FieldGetterHandle.Binder valueOf(String name)
valuesback to summary
public static FieldGetterHandle.Binder[] values()
net.bytebuddy.implementation.bind.annotation back to summary

protected Class FieldGetterHandle.Binder.Delegate

extends TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding<FieldGetterHandle>
Class Inheritance
A delegate implementation for the FieldGetterHandle.Binder.

Constructor Summary

AccessConstructor and Description
protected
Delegate()

Method Summary

Modifier and TypeMethod and Description
protected MethodDelegationBinder.ParameterBinding<?>
bind(FieldDescription
The field for which this binder binds a value.
fieldDescription, AnnotationDescription.Loadable<FieldGetterHandle>
The annotation that was cause for the delegation to this argument binder.
annotation, MethodDescription
The intercepted source method.
source, ParameterDescription
Tge target parameter that is subject to be bound to intercepting the source method.
target, Implementation.Target
The target of the current implementation that is subject to this binding.
implementationTarget, Assigner
An assigner that can be used for applying the binding.
assigner)

Implements abstract net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.bind.

Creates a parameter binding for the given target parameter.
protected TypeDescription
declaringType(AnnotationDescription.Loadable<FieldGetterHandle>
The annotation from which to extract the declaring type.
annotation)

Implements abstract net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.declaringType.

Extracts the declaring type from an annotation.
protected String
fieldName(AnnotationDescription.Loadable<FieldGetterHandle>
The annotation from which to extract the field name.
annotation)

Implements abstract net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.fieldName.

Extracts the field name from an annotation.
public Class<FieldGetterHandle>
getHandledType()

Implements net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.getHandledType.

The annotation type that is handled by this parameter binder.
Inherited from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding:
bind

Constructor Detail

Delegateback to summary
protected Delegate()

Method Detail

bindback to summary
protected MethodDelegationBinder.ParameterBinding<?> bind(FieldDescription fieldDescription, AnnotationDescription.Loadable<FieldGetterHandle> annotation, MethodDescription source, ParameterDescription target, Implementation.Target implementationTarget, Assigner assigner)

Implements abstract net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.bind.

Doc from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.bind.

Creates a parameter binding for the given target parameter.

Parameters
fieldDescription:FieldDescription

The field for which this binder binds a value.

annotation:AnnotationDescription.Loadable<FieldGetterHandle>

The annotation that was cause for the delegation to this argument binder.

source:MethodDescription

The intercepted source method.

target:ParameterDescription

Tge target parameter that is subject to be bound to intercepting the source method.

implementationTarget:Implementation.Target

The target of the current implementation that is subject to this binding.

assigner:Assigner

An assigner that can be used for applying the binding.

Returns:MethodDelegationBinder.ParameterBinding<?>

A parameter binding for the requested target method parameter.

Annotations
@Override
declaringTypeback to summary
protected TypeDescription declaringType(AnnotationDescription.Loadable<FieldGetterHandle> annotation)

Implements abstract net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.declaringType.

Doc from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.declaringType.

Extracts the declaring type from an annotation.

Parameters
annotation:AnnotationDescription.Loadable<FieldGetterHandle>

The annotation from which to extract the declaring type.

Returns:TypeDescription

The declaring type defined by the handled annotation.

Annotations
@Override
fieldNameback to summary
protected String fieldName(AnnotationDescription.Loadable<FieldGetterHandle> annotation)

Implements abstract net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.fieldName.

Doc from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.ForFieldBinding.fieldName.

Extracts the field name from an annotation.

Parameters
annotation:AnnotationDescription.Loadable<FieldGetterHandle>

The annotation from which to extract the field name.

Returns:String

The field name defined by the handled annotation.

Annotations
@Override
getHandledTypeback to summary
public Class<FieldGetterHandle> getHandledType()

Implements net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.getHandledType.

Doc from net.bytebuddy.implementation.bind.annotation.TargetMethodAnnotationDrivenBinder.ParameterBinder.getHandledType.

The annotation type that is handled by this parameter binder.

Returns:Class<FieldGetterHandle>

The java.lang.annotation.Annotation#annotationType() handled by this parameter binder.