com.gh.mygreen.xlsmapper.validation

クラス FieldError

java.lang.Object

com.gh.mygreen.xlsmapper.validation.ObjectError

com.gh.mygreen.xlsmapper.validation.FieldError

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

Serializable

public class FieldError
extends ObjectError

オブジェクトのフィールドであるセルのエラー情報を保持するクラスです。

バージョン:

2.0

作成者:

T.TSUCHIE

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
FieldError(String objectName, String field, boolean conversionFailure, String[] codes, Map<String,Object> variables) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
CellPosition	getAddress() セルのアドレス情報を取得します。
Optional<CellPosition>	getAddressAsOptional() セルのアドレス情報を取得します。
String	getField() フィールド名を取得する。
Object	getRejectedValue() エラートとなったフィールドの値を取得する。
boolean	isConversionFailure() 型変換に失敗したかどうか。
void	setAddress(CellPosition address) セルのアドレス情報を設定します。
void	setRejectedValue(Object rejectedValue) エラートとなったフィールドの値を設定する。

クラスから継承されたメソッド com.gh.mygreen.xlsmapper.validation.ObjectError

getCodes, getDefaultMessage, getLabel, getLabelAsOptional, getObjectName, getSheetName, getVariables, setDefaultMessage, setLabel, setSheetName

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

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

コンストラクタの詳細

FieldError

public FieldError(String objectName,
                  String field,
                  boolean conversionFailure,
                  String[] codes,
                  Map<String,Object> variables)

コンストラクタ

パラメータ:

objectName - オブジェクト名

field - フィールド名

conversionFailure - 型変換に失敗したときのエラーかどうか

codes - メッセージコード

variables - メッセージの引数

メソッドの詳細

isConversionFailure

public boolean isConversionFailure()

型変換に失敗したかどうか。

型変換に失敗した場合、検証対象のBeanやフィールドに値が設定されないないため、 後から値を検証する際に検証をスキップする判定に利用する。

戻り値:

trueの場合、型変換にしっぱいしたエラー。

getField

public String getField()

フィールド名を取得する。

ネストしている場合は、親のパスを付与した形式（e.g. person.name）となります。

戻り値:

Beanにされたフィールドの名称を返す。

getRejectedValue

public Object getRejectedValue()

エラートとなったフィールドの値を取得する。

ただし、型変換エラーの場合、変換前の値となります。

戻り値:

フィールドの値。

setRejectedValue

public void setRejectedValue(Object rejectedValue)

エラートとなったフィールドの値を設定する。

ただし、型変換エラーの場合、変換前の値となります。

パラメータ:

rejectedValue - フィールドの値。

getAddressAsOptional

public Optional<CellPosition> getAddressAsOptional()

セルのアドレス情報を取得します。

戻り値:

設定されていない場合は、空を返します。

getAddress

public CellPosition getAddress()

セルのアドレス情報を取得します。

戻り値:

設定されていない場合は、nullを返します。

setAddress

public void setAddress(CellPosition address)

セルのアドレス情報を設定します。

パラメータ:

address - アドレス情報