Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
Parameter |
|
| 0.0;0 |
1 | // Copyright 2005 The Apache Software Foundation |
|
2 | // |
|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
|
4 | // you may not use this file except in compliance with the License. |
|
5 | // You may obtain a copy of the License at |
|
6 | // |
|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
|
8 | // |
|
9 | // Unless required by applicable law or agreed to in writing, software |
|
10 | // distributed under the License is distributed on an "AS IS" BASIS, |
|
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
12 | // See the License for the specific language governing permissions and |
|
13 | // limitations under the License. |
|
14 | ||
15 | package org.apache.tapestry.annotations; |
|
16 | ||
17 | import java.lang.annotation.Documented; |
|
18 | import java.lang.annotation.ElementType; |
|
19 | import java.lang.annotation.Retention; |
|
20 | import java.lang.annotation.RetentionPolicy; |
|
21 | import java.lang.annotation.Target; |
|
22 | ||
23 | /** |
|
24 | * Used to define a parameter for the component. |
|
25 | * |
|
26 | * @author Howard Lewis Ship |
|
27 | * @since 4.0 |
|
28 | */ |
|
29 | ||
30 | @Target( |
|
31 | { ElementType.METHOD }) |
|
32 | @Retention(RetentionPolicy.RUNTIME) |
|
33 | @Documented |
|
34 | public @interface Parameter { |
|
35 | ||
36 | /** |
|
37 | * If true, then the parameter is required, and must be bound (there is no guarantee that a |
|
38 | * non-null value will be bound however, so the component may have to perform additonal checks). |
|
39 | * The default value, false, means the parameter is optional. |
|
40 | */ |
|
41 | ||
42 | boolean required() default false; |
|
43 | ||
44 | /** |
|
45 | * The default value for the binding, as a binding reference. |
|
46 | */ |
|
47 | ||
48 | String defaultValue() default ""; |
|
49 | ||
50 | /** |
|
51 | * If true (the default), then the binding will cache its value while the component is |
|
52 | * renderering. In some cases, it is desirable to force the binding to be re-evaluated every |
|
53 | * time the parameter property is accessed, in which case cache should be set to false. |
|
54 | */ |
|
55 | ||
56 | boolean cache() default true; |
|
57 | ||
58 | /** |
|
59 | * An optional list of alternate names for the parameter. The parameter may be bound using its |
|
60 | * true name or any alias (but not both!), but use of aliases will generate deprecation |
|
61 | * warnings. |
|
62 | */ |
|
63 | ||
64 | String aliases() default ""; |
|
65 | ||
66 | /** |
|
67 | * The name of the parameter. If not specified, it will match the property name. Note that this |
|
68 | * is backwards from the logic in the XML, where the parameter name is specified and the property name |
|
69 | * matches. |
|
70 | * |
|
71 | */ |
|
72 | ||
73 | String name() default ""; |
|
74 | } |