001// Licensed under the Apache License, Version 2.0 (the "License");
002// you may not use this file except in compliance with the License.
003// You may obtain a copy of the License at
004//
005// http://www.apache.org/licenses/LICENSE-2.0
006//
007// Unless required by applicable law or agreed to in writing, software
008// distributed under the License is distributed on an "AS IS" BASIS,
009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
010// See the License for the specific language governing permissions and
011// limitations under the License.
012
013package org.apache.tapestry5.annotations;
014
015import static java.lang.annotation.ElementType.PARAMETER;
016import static java.lang.annotation.RetentionPolicy.RUNTIME;
017import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.PAGE;
018import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.COMPONENT;
019import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.MIXIN;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025import org.apache.tapestry5.ioc.annotations.UseWith;
026
027/**
028 * Annotation that may be placed on parameters of event handler methods to define their names
029 * in OpenAPI description. This is <em>not</em> needed for an event handler parameter to be
030 * a parameter in a REST endpoint event handler method.
031 *  
032 * @since 5.8.0
033 */
034@Target(
035{ PARAMETER })
036@Retention(RUNTIME)
037@Documented
038@UseWith(
039{ PAGE, COMPONENT, MIXIN })
040public @interface ActivationContextParameter
041{
042    /** 
043     * The name to be used for this parameter in the OpenAPI description.
044     */
045    String value();
046}