Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
ComponentClass |
|
| 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.Inherited; |
|
20 | import java.lang.annotation.Retention; |
|
21 | import java.lang.annotation.RetentionPolicy; |
|
22 | import java.lang.annotation.Target; |
|
23 | ||
24 | /** |
|
25 | * A class-level annotation that identifies a class as a component. Note that values defined by this |
|
26 | * annotation will <strong>override</strong> corresponding values in the XML component |
|
27 | * specification. At this time it is still necessary to have a component specification, even if it |
|
28 | * is empty (this limitation may be lifted before the final 4.0 release). |
|
29 | * |
|
30 | * @author Howard Lewis Ship |
|
31 | * @since 4.0 |
|
32 | */ |
|
33 | @Target( |
|
34 | { ElementType.TYPE }) |
|
35 | @Retention(RetentionPolicy.RUNTIME) |
|
36 | @Documented |
|
37 | @Inherited |
|
38 | public @interface ComponentClass { |
|
39 | ||
40 | /** |
|
41 | * If true (the default), then the defined component will allow and use it's body. Otherwise the |
|
42 | * body is discarded (which may cause errors if the body contains components). |
|
43 | */ |
|
44 | ||
45 | boolean allowBody() default true; |
|
46 | ||
47 | /** |
|
48 | * If true (the default), then the component accepts informal parameters. Generally, informal |
|
49 | * parameters become additional attributes of the element rendered by this component. |
|
50 | */ |
|
51 | ||
52 | boolean allowInformalParameters() default true; |
|
53 | ||
54 | /** |
|
55 | * A comma-seperated list of parameter names that can not be bound informally. These represent |
|
56 | * attributes generated internally by the component, and this is used to prevent name conflicts. |
|
57 | * Comparison of informal parameter name against reserved parameter name is caseless. Note also |
|
58 | * that all formal parameters are automatically part of the list of reserved parameters. |
|
59 | */ |
|
60 | String reservedParameters() default ""; |
|
61 | ||
62 | } |