Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Message |
|
| 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 | * An annotation that may be attached to any method that returns a String. Acts as a wrapper around | |
25 | * {@link org.apache.hivemind.Messages}, converting any parameters into message arguments. | |
26 | * <p> | |
27 | * In many cases, the message key will be deduced from the method name (if not provided): | |
28 | * <ul> | |
29 | * <li>A prefix of "get" is stripped off, and the leading character converted to lower case | |
30 | * <li>Case changes are converted to dashes, i.e., "fooBar" becomes "foo-bar". | |
31 | * </ul> | |
32 | * | |
33 | * @author Howard Lewis Ship | |
34 | * @since 4.0 | |
35 | */ | |
36 | @Target( | |
37 | { ElementType.METHOD }) | |
38 | @Retention(RetentionPolicy.RUNTIME) | |
39 | @Documented | |
40 | public @interface Message { | |
41 | ||
42 | /** | |
43 | * The message key to use. If no such value is defined, it is derived from the method name. | |
44 | */ | |
45 | ||
46 | String value() default ""; | |
47 | } |