nablarch.core.validation.validator

Class RequiredValidator

java.lang.Object

nablarch.core.validation.validator.RequiredValidator

All Implemented Interfaces:

DirectCallableValidator, Validator

public class RequiredValidator
extends java.lang.Object
implements DirectCallableValidator

必須入力をチェックするクラス。

Requiredアノテーションが設定されたプロパティに値が入力されているかをチェックする。

使用するための設定

本バリデータを使用するためにはデフォルトのメッセージIDを指定する必要がある。

      <component class="nablarch.core.validation.validator.RequiredValidator">
         <property name="messageId" value="MSG90001"/>
     </component>
   

必須プロパティの設定

必須入力チェックをしたいプロパティのセッタにRequiredアノテーションを次のように設定する。

      @PropertyName("パスワード")
      @Required
     public void setConfirmPassword(String confirmPassword) {
         this.confirmPassword = confirmPassword;
     }
   

Constructor Summary

Constructors

Constructor and Description
RequiredValidator()

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends java.lang.annotation.Annotation>	getAnnotationClass() 対応するアノテーションのクラスを取得する。
void	setMessageId(java.lang.String messageId) デフォルトのエラーメッセージのメッセージIDを設定する。 例 : "{0}は必ず入力してください。"
<T> boolean	validate(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.lang.annotation.Annotation annotation, java.lang.Object value) バリデーションを実行する。 対応するチェックの結果がNGであった場合、ValidationContextにエラーメッセージを追加し、falseを返す。
<T> boolean	validate(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.Object value) バリデーションを実行する。 対応するチェックの結果がNGであった場合、ValidationContextにエラーメッセージを追加し、falseを返す。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequiredValidator

public RequiredValidator()

Method Detail

setMessageId

public void setMessageId(java.lang.String messageId)

デフォルトのエラーメッセージのメッセージIDを設定する。
例 : "{0}は必ず入力してください。"

Parameters:

messageId - エラーメッセージのデフォルトのメッセージID

getAnnotationClass

public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationClass()

対応するアノテーションのクラスを取得する。

Specified by:

getAnnotationClass in interface Validator

Returns:

対応するアノテーションのクラス

validate

public <T> boolean validate(ValidationContext<T> context,
                            java.lang.String propertyName,
                            java.lang.Object propertyDisplayName,
                            java.lang.annotation.Annotation annotation,
                            java.lang.Object value)

バリデーションを実行する。
対応するチェックの結果がNGであった場合、ValidationContextにエラーメッセージを追加し、falseを返す。

Specified by:

validate in interface Validator

Type Parameters:

T - バリデーション結果で取得できる型

Parameters:

context - バリデーションコンテキスト

propertyName - プロパティ名

propertyDisplayName - プロパティの表示名オブジェクト

annotation - アノテーション

value - バリデーション対象の値

Returns:

バリデーションに通った場合true

validate

public <T> boolean validate(ValidationContext<T> context,
                            java.lang.String propertyName,
                            java.lang.Object propertyDisplayName,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            java.lang.Object value)

バリデーションを実行する。
対応するチェックの結果がNGであった場合、ValidationContextにエラーメッセージを追加し、falseを返す。

Specified by:

validate in interface DirectCallableValidator

Type Parameters:

T - バリデーション結果で取得できる型

Parameters:

context - バリデーションコンテキスト

propertyName - プロパティ名

propertyDisplayName - プロパティの表示名オブジェクト

params - バリデーション処理に対するパラメータを格納したMap (アノテーションの属性と同内容)

value - バリデーション対象の値

Returns:

バリデーションに通った場合true