nablarch.core.validation.convertor

クラス StringConvertor

java.lang.Object

nablarch.core.validation.convertor.StringConvertor

すべての実装されたインタフェース:

Convertor

public class StringConvertor
extends java.lang.Object
implements Convertor

値をStringに変換するクラス。

Stringに変換可能なオブジェクトは、下記クラスのみ

• String
• String[]

トリム仕様

変換可否の判定および変換の際に値の前後の空白文字のトリムを行うか否かを選択することができる。
トリムは、trimPolicyプロパティに設定されたポリシーにしたがって行う。
ポリシーとして設定可能な値を以下に示す。

• "trimAll": すべての文字に対してトリムを行う場合に設定するポリシー
• "noTrim": すべての文字に対してトリムを行わない場合に設定するポリシー

trimPolicyプロパティにポリシーが設定されなかった場合はトリムを行わない（"noTrim"が設定された場合と同様の動作となる）。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
StringConvertor() コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected java.lang.String	applyTrimPolicy(java.lang.String value, java.lang.annotation.Annotation annotation) trimPolicyプロパティに設定されたポリシーにしたがってトリムを実行する。
<T> java.lang.Object	convert(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object value, java.lang.annotation.Annotation format) 変換を行う。
java.lang.Class<?>	getTargetClass() 変換対象のクラスを取得する。
<T> boolean	isConvertible(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.lang.Object value, java.lang.annotation.Annotation format) 変換可否のプレチェックを行う。
void	setAllowNullValue(boolean allowNullValue) 変換対象の値にnullを許可するか否かを設定する。
void	setConversionFailedMessageId(java.lang.String conversionFailedMessageId) 変換失敗時のデフォルトのエラーメッセージのメッセージIDを設定する。
void	setExtendedStringConvertors(java.util.List<ExtendedStringConvertor> extendedStringConvertors) 拡張StringConvertorのリストを設定する。
void	setTrimPolicy(java.lang.String trimPolicy) トリムポリシーを設定する。
protected java.lang.String	trim(java.lang.String value) トリムを実行する。

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

StringConvertor

@Published(tag="architect")
public StringConvertor()

コンストラクタ。

メソッドの詳細

setTrimPolicy

public void setTrimPolicy(java.lang.String trimPolicy)

トリムポリシーを設定する。

パラメータ:

trimPolicy - トリムポリシー

setExtendedStringConvertors

public void setExtendedStringConvertors(java.util.List<ExtendedStringConvertor> extendedStringConvertors)

拡張StringConvertorのリストを設定する。

パラメータ:

extendedStringConvertors - 拡張StringConvertorのリスト

setConversionFailedMessageId

public void setConversionFailedMessageId(java.lang.String conversionFailedMessageId)

変換失敗時のデフォルトのエラーメッセージのメッセージIDを設定する。
デフォルトメッセージの例 : "{0}が正しくありません"

パラメータ:

conversionFailedMessageId - 変換失敗時のデフォルトのエラーメッセージのメッセージID

setAllowNullValue

public void setAllowNullValue(boolean allowNullValue)

変換対象の値にnullを許可するか否かを設定する。

設定を省略した場合、nullが許可される。

パラメータ:

allowNullValue - nullを許可するか否か。許可する場合は、true

convert

public <T> java.lang.Object convert(ValidationContext<T> context,
                                    java.lang.String propertyName,
                                    java.lang.Object value,
                                    java.lang.annotation.Annotation format)

変換を行う。
変換に失敗した場合、ValidationContextにエラー内容を設定する。

定義:

convert インタフェース内 Convertor

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

value - 変換する値(データ型は様々な形式がありえる。)

format - フォーマットを指定するアノテーション（指定がない場合null)

戻り値:

変換結果のオブジェクト

getTargetClass

public java.lang.Class<?> getTargetClass()

変換対象のクラスを取得する。

定義:

getTargetClass インタフェース内 Convertor

戻り値:

変換対象のクラス

isConvertible

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

変換可否のプレチェックを行う。
変換できない文字列であった場合、エラーメッセージをValidationContextに追加し、falseを返却する。

定義:

isConvertible インタフェース内 Convertor

型パラメータ:

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

パラメータ:

context - ValidationContext

propertyName - プロパティ名

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

value - 変換可否のプレチェックを行う値

format - フォーマットを指定するアノテーション（指定がない場合null)

戻り値:

変換できる場合true

applyTrimPolicy

@Published(tag="architect")
protected java.lang.String applyTrimPolicy(java.lang.String value,
                                                                       java.lang.annotation.Annotation annotation)

trimPolicyプロパティに設定されたポリシーにしたがってトリムを実行する。

• ポリシーとして"trimAll"が設定された場合は、すべての文字に対してトリムを行う。
• ポリシーとして"noTrim"が設定された場合、またはポリシーが設定されなかった場合は、トリムを行わない。

パラメータ:

value - トリム対象の文字列

annotation - アノテーション

戻り値:

トリム後の文字列

trim

@Published(tag="architect")
protected java.lang.String trim(java.lang.String value)

トリムを実行する。

Java標準のString.trim()を使用してトリムを行った文字列を返却する。

パラメータ:

value - トリム対象の文字列

戻り値:

トリム後の文字列