001// Copyright 2005 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 015package org.apache.tapestry.annotations; 016 017import java.lang.annotation.Documented; 018import java.lang.annotation.ElementType; 019import java.lang.annotation.Retention; 020import java.lang.annotation.RetentionPolicy; 021import java.lang.annotation.Target; 022 023/** 024 * An annotation that may be attached to any method that returns a String. Acts as a wrapper around 025 * {@link org.apache.hivemind.Messages}, converting any parameters into message arguments. 026 * <p> 027 * In many cases, the message key will be deduced from the method name (if not provided): 028 * <ul> 029 * <li>A prefix of "get" is stripped off, and the leading character converted to lower case 030 * <li>Case changes are converted to dashes, i.e., "fooBar" becomes "foo-bar". 031 * </ul> 032 * 033 * @author Howard Lewis Ship 034 * @since 4.0 035 */ 036@Target( 037{ ElementType.METHOD }) 038@Retention(RetentionPolicy.RUNTIME) 039@Documented 040public @interface Message { 041 042 /** 043 * The message key to use. If no such value is defined, it is derived from the method name. 044 */ 045 046 String value() default ""; 047}