CsvField (Super CSV Annotation 2.3 API)

java.lang.Object
- com.github.mygreen.supercsv.validation.CsvField<T>

型パラメータ:

T - フィールドのクラスタイプ。
```
public class CsvField<T>
extends Object
```
独自にフィールドの値を検証する機能を実装する際のヘルパクラス。

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

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

コンストラクタ
コンストラクタと説明

CsvField(ValidationContext<R> validationContext, R record, String fieldName)

コンストラクタ
コンストラクタと説明
`CsvField(ValidationContext<R> validationContext, R record, String fieldName)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`CsvField<T>`	`add(CsvFieldValidator<T> validator)` フィールドのバリデータを追加する。
`ColumnMapping`	`getColumnMapping()` カラムのマッピング情報
`int`	`getColumnNumber()` フィールドの列番号を取得します。
`List<CsvFieldError>`	`getFieldErrors(CsvBindingErrors bindingErrors)` フィールドのエラー情報を取得する。
`String`	`getLabel()` フィールドのラベルを取得します。
`String`	`getName()` フィールドの名称を取得します。
`Class<T>`	`getType()` フィールドのークラスタイプを取得します。
`ValidationContext<?>`	`getValidationContext()` 入力値検証の情報
`List<CsvFieldValidator<T>>`	`getValidators()` フィールドのValidatorの一覧を取得する。
`T`	`getValue()` フィールドの値を取得します。
`boolean`	`hasError(CsvBindingErrors bindingErrors)` フィールドに対するエラーがあるか検査します。
`boolean`	`hasNotError(CsvBindingErrors bindingErrors)` フィールドに対するエラーがないか検査します。
`boolean`	`isEmpty()` 値が空かどうか判定します。
`boolean`	`isNotEmpty()` 値が空でないかどうか判定します。
`CsvField<T>`	`validate(CsvBindingErrors bindingErrors)` フィールドの値の検証を行う。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - CsvField
```
public CsvField(ValidationContext<R> validationContext,
                R record,
                String fieldName)
```
    型パラメータ:
    
    R - レコードのクラスタイプ。
    
    パラメータ:
    
    validationContext - 入力値検証の情報
    
    record - レコードオブジェクト
    
    fieldName - フィールド名
    
    例外:
    
    NullPointerException - bindingErrors or validationContext or record is null.
    
    IllegalArgumentException - 指定したフィールドがレコードに存在しない場合。
- メソッドの詳細
  - getName
```
public String getName()
```
    フィールドの名称を取得します。
    
    戻り値:
    
    コンストラクタで指定したフィールドの名称。
  - getType
```
public Class<T> getType()
```
    フィールドのークラスタイプを取得します。
    
    戻り値:
    
    クラス情報を返す。
  - getLabel
```
public String getLabel()
```
    フィールドのラベルを取得します。
    
    戻り値:
    
    アノテーションの属性CsvColumn.label()の値を取得します。
  - getColumnNumber
```
public int getColumnNumber()
```
    フィールドの列番号を取得します。
    
    戻り値:
    
    アノテーションの属性CsvColumn.number()の値を取得します。
  - hasError
```
public boolean hasError(CsvBindingErrors bindingErrors)
```
    フィールドに対するエラーがあるか検査します。
    
    パラメータ:
    
    bindingErrors - エラー情報
    
    戻り値:
    
    trueの場合、エラーがあると判定します。
    
    例外:
    
    NullPointerException - bindingErrors is null.
  - hasNotError
```
public boolean hasNotError(CsvBindingErrors bindingErrors)
```
    フィールドに対するエラーがないか検査します。
    
    パラメータ:
    
    bindingErrors - エラー情報
    
    戻り値:
    
    trueの場合、エラーがないと判定します。
    
    例外:
    
    NullPointerException - bindingErrors is null.
    
    関連項目:
    
    hasError(CsvBindingErrors)
  - isEmpty
```
public boolean isEmpty()
```
    値が空かどうか判定します。
    基本的に、nullかどうかで判定しますが、文字列型の場合は空文字かどうかでも判定します。
    
    戻り値:
    
    trueの場合、空と判定します。
  - isNotEmpty
```
public boolean isNotEmpty()
```
    値が空でないかどうか判定します。
    
    戻り値:
    
    trueの場合、非空と判定します。
    
    導入されたバージョン:
    
    isEmpty()
  - add
```
public CsvField<T> add(CsvFieldValidator<T> validator)
```
    フィールドのバリデータを追加する。
    
    パラメータ:
    
    validator - バリデータ。
    
    戻り値:
    
    自身のインスタンス。
    
    例外:
    
    NullPointerException - validator is null.
  - validate
```
public CsvField<T> validate(CsvBindingErrors bindingErrors)
```
    フィールドの値の検証を行う。
    既にエラーがある場合や検証後エラーとなる場合は、その時点で検証を中止する。
    
    パラメータ:
    
    bindingErrors - エラー情報。
    
    戻り値:
    
    自身のインスタンス。
    
    例外:
    
    NullPointerException - bindingErrors is null.
  - getFieldErrors
```
public List<CsvFieldError> getFieldErrors(CsvBindingErrors bindingErrors)
```
    フィールドのエラー情報を取得する。
    
    パラメータ:
    
    bindingErrors - エラー情報
    
    戻り値:
    
    エラーがない場合は空のリストを返します。
    
    例外:
    
    NullPointerException - bindingErrors is null.
  - getValue
```
public T getValue()
```
    フィールドの値を取得します。
    
    戻り値:
    
    CellProcessorでエラーが発生した場合、値はなくnullを返します。
  - getColumnMapping
```
public ColumnMapping getColumnMapping()
```
    カラムのマッピング情報
    
    戻り値:
    
    CsvBeanに定義したカラムのマッピング情報
  - getValidationContext
```
public ValidationContext<?> getValidationContext()
```
    入力値検証の情報
    
    戻り値:
    
    コンストラクタで渡した
  - getValidators
```
public List<CsvFieldValidator<T>> getValidators()
```
    フィールドのValidatorの一覧を取得する。
    
    戻り値:
    
    設定されているCsvFieldValidatorのリストを取得する。

クラス CsvField<T>

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

メソッドのサマリー

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

コンストラクタの詳細

CsvField

メソッドの詳細

getName

getType

getLabel

getColumnNumber

hasError

hasNotError

isEmpty

isNotEmpty

add

validate

getFieldErrors

getValue

getColumnMapping

getValidationContext

getValidators