net.bytebuddy.asm

Class Advice.WithCustomMapping

java.lang.Object

net.bytebuddy.asm.Advice.WithCustomMapping

Enclosing class:

Advice

public static class Advice.WithCustomMapping
extends Object

A builder step for creating an Advice that uses custom mappings of annotations to constant pool values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WithCustomMapping() Creates a new custom mapping builder step without including any custom mappings.
protected	WithCustomMapping(Map<Class<? extends Annotation>,Advice.DynamicValue<?>> dynamicValues) Creates a new custom mapping builder step with the given custom mappings.

Method Summary

Modifier and Type	Method and Description
<T extends Annotation> Advice.WithCustomMapping	bind(Class<? extends T> type, Advice.DynamicValue<T> dynamicValue) Binds an annotation type to dynamically computed value.
<T extends Annotation> Advice.WithCustomMapping	bind(Class<? extends T> type, Serializable value) Binds the supplied annotation to the supplied fixed value.
<T extends Annotation> Advice.WithCustomMapping	bind(Class<? extends T> type, TypeDescription value) Binds the supplied annotation to the supplied fixed value.
<T extends Annotation> Advice.WithCustomMapping	bindProperty(Class<? extends T> type, String property) Binds the supplied annotation to the annotation's property of the specified name.
boolean	equals(Object other)
int	hashCode()
Advice	to(Class<?> advice) Implements advice where every matched method is advised by the given type's advisory methods.
Advice	to(Class<?> enterAdvice, Class<?> exitAdvice) Implements advice where every matched method is advised by the given type's advisory methods.
Advice	to(Class<?> enterAdvice, Class<?> exitAdvice, ClassFileLocator classFileLocator) Implements advice where every matched method is advised by the given type's advisory methods.
Advice	to(Class<?> advice, ClassFileLocator classFileLocator) Implements advice where every matched method is advised by the given type's advisory methods.
Advice	to(TypeDescription advice, ClassFileLocator classFileLocator) Implements advice where every matched method is advised by the given type's advisory methods.
Advice	to(TypeDescription enterAdvice, TypeDescription exitAdvice) Implements advice where every matched method is advised by the given type's advisory methods.
Advice	to(TypeDescription enterAdvice, TypeDescription exitAdvice, ClassFileLocator classFileLocator) Implements advice where every matched method is advised by the given type's advisory methods.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WithCustomMapping

protected WithCustomMapping()

Creates a new custom mapping builder step without including any custom mappings.

WithCustomMapping

protected WithCustomMapping(Map<Class<? extends Annotation>,Advice.DynamicValue<?>> dynamicValues)

Creates a new custom mapping builder step with the given custom mappings.

Parameters:

dynamicValues - A map containing dynamically computed constant pool values that are mapped by their triggering annotation type.

Method Detail

bind

public <T extends Annotation> Advice.WithCustomMapping bind(Class<? extends T> type,
                                                            TypeDescription value)

Binds the supplied annotation to the supplied fixed value.

Type Parameters:

T - The annotation type.

Parameters:

type - The type of the annotation being bound.

value - The type reference to bind to this annotation.

Returns:

A new builder for an advice that considers the supplied annotation type during binding.

See Also:

Advice.DynamicValue.ForFixedValue

bind

public <T extends Annotation> Advice.WithCustomMapping bind(Class<? extends T> type,
                                                            Serializable value)

Binds the supplied annotation to the supplied fixed value.

Type Parameters:

T - The annotation type.

Parameters:

type - The type of the annotation being bound.

value - The value to bind to this annotation.

Returns:

A new builder for an advice that considers the supplied annotation type during binding.

See Also:

Advice.DynamicValue.ForFixedValue

bindProperty

public <T extends Annotation> Advice.WithCustomMapping bindProperty(Class<? extends T> type,
                                                                    String property)

Binds the supplied annotation to the annotation's property of the specified name.

Type Parameters:

T - The annotation type.

Parameters:

type - The type of the annotation being bound.

property - The name of the annotation property to be bound.

Returns:

A new builder for an advice that considers the supplied annotation during binding.

bind

public <T extends Annotation> Advice.WithCustomMapping bind(Class<? extends T> type,
                                                            Advice.DynamicValue<T> dynamicValue)

Binds an annotation type to dynamically computed value. Whenever the Advice component discovers the given annotation on a parameter of an advice method, the dynamic value is asked to provide a value that is then assigned to the parameter in question.

Type Parameters:

T - The annotation type.

Parameters:

type - The annotation type that triggers the mapping.

dynamicValue - The dynamic value that is computed for binding the parameter to a value.

Returns:

A new builder for an advice that considers the supplied annotation type during binding.

to

public Advice to(Class<?> advice)

Implements advice where every matched method is advised by the given type's advisory methods. The advices binary representation is accessed by querying the class loader of the supplied class for a class file.

Parameters:

advice - The type declaring the advice.

Returns:

A method visitor wrapper representing the supplied advice.

to

public Advice to(Class<?> advice,
                 ClassFileLocator classFileLocator)

Implements advice where every matched method is advised by the given type's advisory methods.

Parameters:

advice - The type declaring the advice.

classFileLocator - The class file locator for locating the advisory class's class file.

Returns:

A method visitor wrapper representing the supplied advice.

to

public Advice to(TypeDescription advice,
                 ClassFileLocator classFileLocator)

Implements advice where every matched method is advised by the given type's advisory methods.

Parameters:

advice - A description of the type declaring the advice.

classFileLocator - The class file locator for locating the advisory class's class file.

Returns:

A method visitor wrapper representing the supplied advice.

to

public Advice to(Class<?> enterAdvice,
                 Class<?> exitAdvice)

Implements advice where every matched method is advised by the given type's advisory methods. The advices binary representation is accessed by querying the class loader of the supplied class for a class file.

Parameters:

enterAdvice - The type declaring the enter advice.

exitAdvice - The type declaring the exit advice.

Returns:

A method visitor wrapper representing the supplied advice.

to

public Advice to(Class<?> enterAdvice,
                 Class<?> exitAdvice,
                 ClassFileLocator classFileLocator)

Implements advice where every matched method is advised by the given type's advisory methods.

Parameters:

enterAdvice - The type declaring the enter advice.

exitAdvice - The type declaring the exit advice.

classFileLocator - The class file locator for locating the advisory class's class file.

Returns:

A method visitor wrapper representing the supplied advice.

to

public Advice to(TypeDescription enterAdvice,
                 TypeDescription exitAdvice)

Implements advice where every matched method is advised by the given type's advisory methods. Using this method, a non-operational class file locator is specified for the advice target. This implies that only advice targets with the inline target set to false are resolvable by the returned instance.

Parameters:

enterAdvice - The type declaring the enter advice.

exitAdvice - The type declaring the exit advice.

Returns:

A method visitor wrapper representing the supplied advice.

to

public Advice to(TypeDescription enterAdvice,
                 TypeDescription exitAdvice,
                 ClassFileLocator classFileLocator)

Implements advice where every matched method is advised by the given type's advisory methods.

Parameters:

enterAdvice - The type declaring the enter advice.

exitAdvice - The type declaring the exit advice.

classFileLocator - The class file locator for locating the advisory class's class file.

Returns:

A method visitor wrapper representing the supplied advice.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object