001    // Copyright 2009 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.annotations;
016    
017    import java.lang.annotation.*;
018    
019    import static org.apache.tapestry5.ioc.annotations.AnnotationUseContext.*;
020    import org.apache.tapestry5.ioc.annotations.UseWith;
021    
022    /**
023     * Annotation applied to components to document what events a component may trigger. This is primarily used when
024     * generating component reference documentation. It is expressly <em>not</em> checked or used at runtime.
025     *
026     * @since 5.1.0.4
027     */
028    @Target(ElementType.TYPE)
029    @Retention(RetentionPolicy.SOURCE)
030    @Documented
031    @UseWith({COMPONENT, MIXIN})
032    public @interface Events
033    {
034        /**
035         * A number of strings that define the events; each string is an event name optionally followed by whitespace and
036         * documentation about when the event is triggered.
037         */
038        String[] value();
039    }