1 /*
2 * $Id: Parameter.java 1044817 2010-12-12 13:22:01Z apetrelli $
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21 package org.apache.tiles.autotag.core.runtime.annotation;
22
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26 import java.lang.annotation.Target;
27
28 /**
29 * Specifies behaviour for a parameter of the "execute" method of a template class.
30 *
31 * @version $Rev: 1044817 $ $Date: 2010-12-12 14:22:01 +0100 (Sun, 12 Dec 2010) $
32 */
33 @Retention(RetentionPolicy.SOURCE)
34 @Target(ElementType.PARAMETER)
35 public @interface Parameter {
36
37 /**
38 * Indicates to use the parameter name itself for the exported name.
39 */
40 String SAME_NAME = "USE THE SAME NAME";
41
42 /**
43 * Returns the name of the exported property name.
44 */
45 String name() default SAME_NAME;
46
47 /**
48 * Indicates that this parameter is required.
49 */
50 boolean required() default false;
51
52 /**
53 * Indicates the default value, as it will be written in Java code.
54 */
55 String defaultValue() default "null";
56 }