com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument Maven / Gradle / Ivy
The newest version!
package com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation;
import com.ui4j.bytebuddy.instrumentation.Instrumentation;
import com.ui4j.bytebuddy.instrumentation.attribute.annotation.AnnotationDescription;
import com.ui4j.bytebuddy.instrumentation.method.MethodDescription;
import com.ui4j.bytebuddy.instrumentation.method.ParameterDescription;
import com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.ArgumentTypeResolver;
import com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.MethodDelegationBinder;
import com.ui4j.bytebuddy.instrumentation.method.bytecode.stack.StackManipulation;
import com.ui4j.bytebuddy.instrumentation.method.bytecode.stack.assign.Assigner;
import com.ui4j.bytebuddy.instrumentation.method.bytecode.stack.member.MethodVariableAccess;
import com.ui4j.bytebuddy.instrumentation.type.TypeDescription;
import java.lang.annotation.*;
import java.util.Iterator;
import java.util.LinkedHashSet;
/**
* Parameters that are annotated with this annotation will be assigned the value of the parameter of the source method
* with the given parameter. For example, if source method {@code foo(String, Integer)} is bound to target method
* {@code bar(@Argument(1) Integer)}, the second parameter of {@code foo} will be bound to the first argument of
* {@code bar}.
*
* If a source method has less parameters than specified by {@link Argument#value()}, the method carrying this parameter
* annotation is excluded from the list of possible binding candidates to this particular source method. The same happens,
* if the source method parameter at the specified index is not assignable to the annotated parameter.
*
* @see com.ui4j.bytebuddy.instrumentation.MethodDelegation
* @see TargetMethodAnnotationDrivenBinder
* @see com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.RuntimeType
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface Argument {
/**
* The index of the parameter of the source method that should be bound to this parameter.
*
* @return The required parameter index.
*/
int value();
/**
* Determines if the argument binding is to be considered by a
* {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.ArgumentTypeResolver}
* for resolving ambiguous bindings of two methods. If
* {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument.BindingMechanic#UNIQUE},
* of two bindable target methods such as for example {@code foo(String)} and {@code bar(Object)}, the {@code foo}
* method would be considered as dominant over the {@code bar} method because of its more specific argument type. As
* a side effect, only one parameter of any target method can be bound to a source method parameter with a given
* index unless the {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument.BindingMechanic#ANONYMOUS}
* option is used for any other binding.
*
* @return The binding type that should be applied to this parameter binding.
* @see com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.ArgumentTypeResolver
*/
BindingMechanic bindingMechanic() default BindingMechanic.UNIQUE;
/**
* Determines if a parameter binding should be considered for resolving ambiguous method bindings.
*
* @see Argument#bindingMechanic()
* @see com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.ArgumentTypeResolver
*/
static enum BindingMechanic {
/**
* The binding is unique, i.e. only one such binding must be present among all parameters of a method. As a
* consequence, the binding can be latter identified by an
* {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.MethodDelegationBinder.AmbiguityResolver}.
*/
UNIQUE {
@Override
protected MethodDelegationBinder.ParameterBinding makeBinding(TypeDescription sourceType,
TypeDescription targetType,
int sourceParameterIndex,
Assigner assigner,
boolean dynamicallyTyped,
int parameterOffset) {
return MethodDelegationBinder.ParameterBinding.Unique.of(
new StackManipulation.Compound(
MethodVariableAccess.forType(sourceType).loadOffset(parameterOffset),
assigner.assign(sourceType, targetType, dynamicallyTyped)),
new ArgumentTypeResolver.ParameterIndexToken(sourceParameterIndex)
);
}
},
/**
* The binding is anonymous, i.e. it can be present on several parameters of the same method.
*/
ANONYMOUS {
@Override
protected MethodDelegationBinder.ParameterBinding makeBinding(TypeDescription sourceType,
TypeDescription targetType,
int sourceParameterIndex,
Assigner assigner,
boolean dynamicallyTyped,
int parameterOffset) {
return new MethodDelegationBinder.ParameterBinding.Anonymous(
new StackManipulation.Compound(
MethodVariableAccess.forType(sourceType).loadOffset(parameterOffset),
assigner.assign(sourceType, targetType, dynamicallyTyped))
);
}
};
/**
* Creates a binding that corresponds to this binding mechanic.
*
* @param sourceType The source type to be bound.
* @param targetType The target type the {@code sourceType} is to be bound to.
* @param sourceParameterIndex The index of the source parameter.
* @param assigner The assigner that is used to perform the assignment.
* @param dynamicallyTyped If {@code true}, the assignment is allowed to consider runtime types.
* @param parameterOffset The offset of the source method's parameter.
* @return A binding considering the chosen binding mechanic.
*/
protected abstract MethodDelegationBinder.ParameterBinding makeBinding(TypeDescription sourceType,
TypeDescription targetType,
int sourceParameterIndex,
Assigner assigner,
boolean dynamicallyTyped,
int parameterOffset);
}
/**
* A binder for handling the
* {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument}
* annotation.
*
* @see TargetMethodAnnotationDrivenBinder
*/
static enum Binder implements TargetMethodAnnotationDrivenBinder.ParameterBinder {
/**
* The singleton instance.
*/
INSTANCE;
@Override
public Class getHandledType() {
return Argument.class;
}
@Override
public MethodDelegationBinder.ParameterBinding bind(AnnotationDescription.Loadable annotation,
MethodDescription source,
ParameterDescription target,
Instrumentation.Target instrumentationTarget,
Assigner assigner) {
Argument argument = annotation.loadSilent();
if (argument.value() < 0) {
throw new IllegalArgumentException(String.format("Argument annotation on %d's argument virtual " +
"%s holds negative index", target.getIndex(), target));
} else if (source.getParameters().size() <= argument.value()) {
return MethodDelegationBinder.ParameterBinding.Illegal.INSTANCE;
}
return argument.bindingMechanic().makeBinding(source.getParameters().get(argument.value()).getTypeDescription(),
target.getTypeDescription(),
argument.value(),
assigner,
RuntimeType.Verifier.check(target),
source.getParameters().get(argument.value()).getOffset());
}
}
/**
* If this defaults provider is active, a non-annotated parameter is assumed to be implicitly bound to the next
* source method parameter that is not bound by any other target method parameter, i.e. a target method
* {@code bar(Object, String)} would be equivalent to a {@code bar(@Argument(0) Object, @Argument(1) String)}.
*
* @see TargetMethodAnnotationDrivenBinder.DefaultsProvider
*/
static enum NextUnboundAsDefaultsProvider implements TargetMethodAnnotationDrivenBinder.DefaultsProvider {
/**
* The singleton instance.
*/
INSTANCE;
/**
* Creates a list of all parameter indices of a source method that are not explicitly referenced
* by any {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument} annotation on
* the target method.
*
* @param source The source method.
* @param target The target method.
* @return An iterator over all parameter indices of the source method that are not explicitly referenced
* by the target method in increasing order.
*/
private static Iterator makeFreeIndexList(MethodDescription source, MethodDescription target) {
LinkedHashSet results = new LinkedHashSet(source.getParameters().size());
for (int sourceIndex = 0; sourceIndex < source.getParameters().size(); sourceIndex++) {
results.add(sourceIndex);
}
for (ParameterDescription parameterDescription : target.getParameters()) {
AnnotationDescription.Loadable annotation = parameterDescription.getDeclaredAnnotations().ofType(Argument.class);
if (annotation != null) {
results.remove(annotation.loadSilent().value());
}
}
return results.iterator();
}
@Override
public Iterator makeIterator(Instrumentation.Target instrumentationTarget,
MethodDescription source,
MethodDescription target) {
return new NextUnboundArgumentIterator(makeFreeIndexList(source, target));
}
/**
* An iterator that creates {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument}
* annotations for any non-referenced index of the source method.
*/
protected static class NextUnboundArgumentIterator implements Iterator {
/**
* An iterator over all free indices.
*/
private final Iterator iterator;
/**
* Creates a new iterator for {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument}
* annotations of non-referenced parameter indices of the source method.
*
* @param iterator An iterator of free indices of the source method.
*/
protected NextUnboundArgumentIterator(Iterator iterator) {
this.iterator = iterator;
}
@Override
public boolean hasNext() {
return iterator.hasNext();
}
@Override
public AnnotationDescription next() {
return AnnotationDescription.ForLoadedAnnotation.of(new DefaultArgument(iterator.next()));
}
@Override
public void remove() {
iterator.remove();
}
/**
* A default implementation of an {@link com.ui4j.bytebuddy.instrumentation.method.bytecode.bind.annotation.Argument}
* annotation.
*/
protected static class DefaultArgument implements Argument {
/**
* The name of the value annotation parameter.
*/
private static final String VALUE = "value";
/**
* The name of the value binding mechanic parameter.
*/
private static final String BINDING_MECHANIC = "bindingMechanic";
/**
* The index of the source method parameter to be bound.
*/
private final int parameterIndex;
/**
* Creates a new instance of an argument annotation.
*
* @param parameterIndex The index of the source method parameter to be bound.
*/
protected DefaultArgument(int parameterIndex) {
this.parameterIndex = parameterIndex;
}
@Override
public int value() {
return parameterIndex;
}
@Override
public BindingMechanic bindingMechanic() {
return BindingMechanic.UNIQUE;
}
@Override
public Class annotationType() {
return Argument.class;
}
@Override
public boolean equals(Object other) {
return this == other || other instanceof Argument && parameterIndex == ((Argument) other).value();
}
@Override
public int hashCode() {
return ((127 * BINDING_MECHANIC.hashCode()) ^ BindingMechanic.UNIQUE.hashCode())
+ ((127 * VALUE.hashCode()) ^ parameterIndex);
}
@Override
public String toString() {
return "@" + Argument.class.getName() + "(bindingMechanic=" + BindingMechanic.UNIQUE.name()
+ ", value=" + parameterIndex + ")";
}
}
}
}
}