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 /**
020 * Annotation applied to components to document what events a component may trigger. This is primarily used when
021 * generating component reference documentation. It is expressly <em>not</em> checked used at runtime.
022 *
023 * @since 5.1.0.4
024 */
025 @Target(ElementType.TYPE)
026 @Retention(RetentionPolicy.SOURCE)
027 @Documented
028 public @interface Events
029 {
030 /**
031 * A number of strings that define the events; each string is an event name optionally followed by whitespace and
032 * documentation about when the event is triggered.
033 */
034 String[] value();
035 }