1 /*
2 * Copyright 2004-2010 the Seasar Foundation and the Others.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16
17 package org.seasar.cubby.action;
18
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 import org.seasar.cubby.converter.Converter;
25
26 /**
27 * 要求パラメータのバインド対象であることを表す注釈です。
28 * <p>
29 * 以下のいずれかの場合に、この注釈で修飾された属性(プロパティまたはフィールド)が要求パラメータをバインドする対象になります。
30 * <ul>
31 * <li>アクションメソッド(またはクラス)が {@link Form} で修飾されていない</li>
32 * <li>アクションメソッド(またはクラス)が {@link Form} で修飾されていて、{@link Form#bindingType()} に
33 * {@link RequestParameterBindingType#ONLY_SPECIFIED_PROPERTIES} が指定されている</li>
34 * </ul>
35 * </p>
36 *
37 * @see Form
38 * @see RequestParameterBindingType
39 * @see RequestParameterBindingType#ONLY_SPECIFIED_PROPERTIES
40 * @author baba
41 */
42 @Retention(RetentionPolicy.RUNTIME)
43 @Target( { ElementType.METHOD, ElementType.FIELD })
44 public @interface RequestParameter {
45
46 /** バインドする要求パラメータ名、指定しない場合は属性名が使用されます。 */
47 String name() default "";
48
49 /** 型変換に用いるコンバータ、指定しない場合はプロパティの型によって自動的に選択されます。 */
50 Class<? extends Converter> converter() default Converter.class;
51
52 }