View Javadoc

1   /*
2    * Copyright 2004-2009 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  package org.seasar.cubby.action;
17  
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  import org.seasar.cubby.converter.Converter;
24  
25  /**
26   * 要求パラメータのバインド対象であることを表す注釈です。
27   * <p>
28   * 以下のいずれかの場合に、この注釈で修飾された属性(プロパティまたはフィールド)が要求パラメータをバインドする対象になります。
29   * <ul>
30   * <li>アクションメソッド(またはクラス)が {@link Form} で修飾されていない</li>
31   * <li>アクションメソッド(またはクラス)が {@link Form} で修飾されていて、{@link Form#bindingType()} に
32   * {@link RequestParameterBindingType#ONLY_SPECIFIED_PROPERTIES} が指定されている</li>
33   * </ul>
34   * </p>
35   * 
36   * @see Form
37   * @see RequestParameterBindingType
38   * @see RequestParameterBindingType#ONLY_SPECIFIED_PROPERTIES
39   * @author baba
40   */
41  @Retention(RetentionPolicy.RUNTIME)
42  @Target( { ElementType.METHOD, ElementType.FIELD })
43  public @interface RequestParameter {
44  
45  	/** バインドする要求パラメータ名、指定しない場合は属性名が使用されます。 */
46  	String name() default "";
47  
48  	/** 型変換に用いるコンバータ、指定しない場合はプロパティの型によって自動的に選択されます。 */
49  	Class<? extends Converter> converter() default Converter.class;
50  
51  }