FieldAccessor.ForNamedField (Byte Buddy (with dependencies) 0.5 API)

java.lang.Object
- net.bytebuddy.instrumentation.FieldAccessor
- - net.bytebuddy.instrumentation.FieldAccessor.ForNamedField

All Implemented Interfaces:

FieldAccessor.AssignerConfigurable, FieldAccessor.FieldDefinable, FieldAccessor.OwnerTypeLocatable, Instrumentation

Enclosing class:

FieldAccessor
```
protected static class FieldAccessor.ForNamedField
extends FieldAccessor
implements FieldAccessor.FieldDefinable
```
Implementation of a field accessor instrumentation where the field name is given explicitly.

Property Summary
- Properties inherited from class net.bytebuddy.instrumentation.FieldAccessor
  ofBeanProperty

Nested Class Summary
- Nested classes/interfaces inherited from class net.bytebuddy.instrumentation.FieldAccessor
  FieldAccessor.Appender, FieldAccessor.AssignerConfigurable, FieldAccessor.FieldDefinable, FieldAccessor.FieldLocator, FieldAccessor.FieldNameExtractor, FieldAccessor.ForNamedField, FieldAccessor.ForUnnamedField, FieldAccessor.OwnerTypeLocatable
- Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.Instrumentation
  Instrumentation.Compound, Instrumentation.Context, Instrumentation.ForAbstractMethod, Instrumentation.Simple, Instrumentation.SpecialMethodInvocation, Instrumentation.Target

Field Summary
- Fields inherited from class net.bytebuddy.instrumentation.FieldAccessor
  assigner, considerRuntimeType

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ForNamedField(Assigner assigner, boolean considerRuntimeType, String fieldName)` Creates a field accessor instrumentation for a field of a given name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteCodeAppender`	`appender(Instrumentation.Target instrumentationTarget)` Creates a byte code appender that determines the implementation of the instrumented type's methods.
`FieldAccessor.AssignerConfigurable`	`defineAs(Class<?> type, ModifierContributor.ForField... modifier)` Defines a field with the given name in the instrumented type.
`FieldAccessor.AssignerConfigurable`	`defineAs(TypeDescription typeDescription, ModifierContributor.ForField... modifier)` Defines a field with the given name in the instrumented type.
`boolean`	`equals(Object other)`
`protected String`	`getFieldName(MethodDescription targetMethod)` Locates a field's name.
`int`	`hashCode()`
`FieldAccessor.AssignerConfigurable`	`in(Class<?> type)` Determines that a field should only be considered when it was defined in a given type.
`FieldAccessor.AssignerConfigurable`	`in(FieldAccessor.FieldLocator.Factory fieldLocatorFactory)` Determines that a field should only be considered when it was identified by a field locator that is produced by the given factory.
`FieldAccessor.AssignerConfigurable`	`in(TypeDescription typeDescription)` Determines that a field should only be considered when it was defined in a given type.
`InstrumentedType`	`prepare(InstrumentedType instrumentedType)` During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type.
`String`	`toString()`
`Instrumentation`	`withAssigner(Assigner assigner, boolean considerRuntimeType)` Returns a field accessor that is identical to this field accessor but uses the given assigner and runtime type use configuration.

Methods inherited from class net.bytebuddy.instrumentation.FieldAccessor
applyGetter, applySetter, of, ofBeanProperty, ofField

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ForNamedField
```
protected ForNamedField(Assigner assigner,
                        boolean considerRuntimeType,
                        String fieldName)
```
    Creates a field accessor instrumentation for a field of a given name.
    
    Parameters:
    
    assigner - The assigner to use.
    
    considerRuntimeType - true if a field value's runtime type should be considered.
    
    fieldName - The name of the field.
- Method Detail
  - defineAs
```
public FieldAccessor.AssignerConfigurable defineAs(Class<?> type,
                                                   ModifierContributor.ForField... modifier)
```
    Description copied from interface: FieldAccessor.FieldDefinable
    
    Defines a field with the given name in the instrumented type.
    
    Specified by:
    
    defineAs in interface FieldAccessor.FieldDefinable
    
    Parameters:
    
    type - The type of the field.
    
    modifier - The modifiers for the field.
    
    Returns:
    
    A field accessor that defines a field of the given type.
  - defineAs
```
public FieldAccessor.AssignerConfigurable defineAs(TypeDescription typeDescription,
                                                   ModifierContributor.ForField... modifier)
```
    Description copied from interface: FieldAccessor.FieldDefinable
    
    Defines a field with the given name in the instrumented type.
    
    Specified by:
    
    defineAs in interface FieldAccessor.FieldDefinable
    
    Parameters:
    
    typeDescription - The type of the field.
    
    modifier - The modifiers for the field.
    
    Returns:
    
    A field accessor that defines a field of the given type.
  - in
```
public FieldAccessor.AssignerConfigurable in(FieldAccessor.FieldLocator.Factory fieldLocatorFactory)
```
    Description copied from interface: FieldAccessor.OwnerTypeLocatable
    
    Determines that a field should only be considered when it was identified by a field locator that is produced by the given factory.
    
    Specified by:
    
    in in interface FieldAccessor.OwnerTypeLocatable
    
    Parameters:
    
    fieldLocatorFactory - A factory that will produce a field locator that will be used to find locate a field to be accessed.
    
    Returns:
    
    This field accessor which will only considered fields that are defined in the given type.
  - in
```
public FieldAccessor.AssignerConfigurable in(Class<?> type)
```
    Description copied from interface: FieldAccessor.OwnerTypeLocatable
    
    Determines that a field should only be considered when it was defined in a given type.
    
    Specified by:
    
    in in interface FieldAccessor.OwnerTypeLocatable
    
    Parameters:
    
    type - The type to be considered.
    
    Returns:
    
    This field accessor which will only considered fields that are defined in the given type.
  - in
```
public FieldAccessor.AssignerConfigurable in(TypeDescription typeDescription)
```
    Description copied from interface: FieldAccessor.OwnerTypeLocatable
    
    Determines that a field should only be considered when it was defined in a given type.
    
    Specified by:
    
    in in interface FieldAccessor.OwnerTypeLocatable
    
    Parameters:
    
    typeDescription - A description of the type to be considered.
    
    Returns:
    
    This field accessor which will only considered fields that are defined in the given type.
  - withAssigner
```
public Instrumentation withAssigner(Assigner assigner,
                                    boolean considerRuntimeType)
```
    Description copied from interface: FieldAccessor.AssignerConfigurable
    
    Returns a field accessor that is identical to this field accessor but uses the given assigner and runtime type use configuration.
    
    Specified by:
    
    withAssigner in interface FieldAccessor.AssignerConfigurable
    
    Parameters:
    
    assigner - The assigner to use.
    
    considerRuntimeType - true if a field value's runtime type should be considered.
    
    Returns:
    
    This field accessor with the given assigner and runtime type use configuration.
  - prepare
```
public InstrumentedType prepare(InstrumentedType instrumentedType)
```
    Description copied from interface: Instrumentation
    
    During the preparation phase of an instrumentation, implementations are eligible to adding fields or methods to the currently instrumented type. All methods that are added by this instrumentation are required to be implemented by the ByteCodeAppender that is emitted on the call to Instrumentation.appender(net.bytebuddy.instrumentation.Instrumentation.Target) call. On this method call, loaded type initializers can also be added to the instrumented type.
    
    Specified by:
    
    prepare in interface Instrumentation
    
    Parameters:
    
    instrumentedType - The instrumented type that is the basis of the ongoing instrumentation.
    
    Returns:
    
    The instrumented type with any applied changes, if any.
  - appender
```
public ByteCodeAppender appender(Instrumentation.Target instrumentationTarget)
```
    Description copied from interface: Instrumentation
    
    Creates a byte code appender that determines the implementation of the instrumented type's methods.
    
    Specified by:
    
    appender in interface Instrumentation
    
    Parameters:
    
    instrumentationTarget - The target of the current instrumentation.
    
    Returns:
    
    A byte code appender for implementing methods delegated to this instrumentation. This byte code appender is also responsible for handling methods that were added by this instrumentation on the call to Instrumentation.prepare(net.bytebuddy.instrumentation.type.InstrumentedType).
  - getFieldName
```
protected String getFieldName(MethodDescription targetMethod)
```
    Description copied from class: FieldAccessor
    
    Locates a field's name.
    
    Specified by:
    
    getFieldName in class FieldAccessor
    
    Parameters:
    
    targetMethod - The method that is target of the instrumentation.
    
    Returns:
    
    The name of the field to be located for this instrumentation.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class FieldAccessor
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class FieldAccessor
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FieldAccessor.ForNamedField

Property Summary

Properties inherited from class net.bytebuddy.instrumentation.FieldAccessor

Nested Class Summary

Nested classes/interfaces inherited from class net.bytebuddy.instrumentation.FieldAccessor

Nested classes/interfaces inherited from interface net.bytebuddy.instrumentation.Instrumentation

Field Summary

Fields inherited from class net.bytebuddy.instrumentation.FieldAccessor

Constructor Summary

Method Summary

Methods inherited from class net.bytebuddy.instrumentation.FieldAccessor

Methods inherited from class java.lang.Object

Constructor Detail

ForNamedField

Method Detail

defineAs

defineAs

in

in

in

withAssigner

prepare

appender

getFieldName

equals

hashCode

toString