org.glowroot.plugin.api.weaving.BindParameter Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2012-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.glowroot.plugin.api.weaving;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Annotates parameters to any {@literal @}{@link Pointcut} advice method
*
* ({@literal @}{@link IsEnabled}, {@literal @}{@link OnBefore}, {@literal @}{@link OnReturn},
* {@literal @}{@link OnThrow}, {@literal @}{@link OnAfter}).
*
* When the advice method is called, the parameters passed to the method matched by the
* {@link Pointcut} are bound to these parameters.
*
* There cannot be more {@literal @}{@link BindParameter} parameters than the number of arguments
* passed to the {@link Pointcut} method. If {@code ".."} is used at the end of
* {@link Pointcut#methodParameterTypes()} and the number of arguments is unknown, then
* {@link BindParameterArray} can be used to bind all arguments to a single parameter of type
* {@code Object[]}.
*/
@Target(PARAMETER)
@Retention(RUNTIME)
public @interface BindParameter {}