CsvBindingErrors (Super CSV Annotation 2.3 API)

java.lang.Object
- com.github.mygreen.supercsv.validation.CsvBindingErrors

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

Serializable
```
public class CsvBindingErrors
extends Object
implements Serializable
```
CSVのエラー情報を管理するためのクラス。
SpringFrameworkのBindingResultを参考。

現状、ネストしたフィールドはサポートしていないため、パスの機能を省略して実装する。

導入されたバージョン:

2.0

バージョン:

2.2

作成者:

T.TSUCHIE

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String PATH_SEPARATOR
パスの区切り文字

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`PATH_SEPARATOR` パスの区切り文字

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

コンストラクタ
コンストラクタと説明
`CsvBindingErrors(Class<?> clazz)` クラス名を元にオブジェクト名を設定するコンストラクタ。
`CsvBindingErrors(String objectName)` オブジェクト名を指定するコンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAllErrors(Collection<CsvError> errors)` 全てのエラー情報を追加する。
`void`	`addError(CsvError error)` エラーを追加する
`void`	`clearAllErrors()` 全てのエラー情報を削除する。
`List<CsvError>`	`getAllErrors()` 全てのエラー情報を取得する。
`int`	`getFieldErrorCount()` フィールドエラーの件数を取得する。
`int`	`getFieldErrorCount(String path)` 指定したパスのフィィールドエラーの件数を取得する。
`List<CsvFieldError>`	`getFieldErrors()` フィールドエラーを取得する
`List<CsvFieldError>`	`getFieldErrors(String path)` パスを指定してフィールドエラーを取得する
`CsvFieldError`	`getFirstFieldError()` 先頭のフィールドエラーを取得する
`CsvFieldError`	`getFirstFieldError(String path)` パスを指定して先頭のフィールドエラーを取得する
`CsvError`	`getFirstGlobalError()` 先頭のグローバルエラーを取得する。
`int`	`getGlobalErrorCount()` グローバルエラーの件数を取得する
`List<CsvError>`	`getGlobalErrors()` グローバルエラーを取得する
`MessageCodeGenerator`	`getMessageCodeGenerator()`
`String`	`getObjectName()` オブジェクト名の取得
`boolean`	`hasErrors()` エラー情報が存在するかどうか確かめる。
`boolean`	`hasFieldErrors()` フィールドエラーが存在するか確かめる。
`boolean`	`hasFieldErrors(String path)` 指定したパスのフィィールドエラーが存在するか確かめる。
`boolean`	`hasGlobalErrors()` グローバルエラーがあるか確かめる。
`void`	`reject(String errorCode)` グローバルエラーを登録する。
`void`	`reject(String[] errorCodes, Map<String,Object> messageVariables, String defaultMessage)` グローバルエラーを登録する。
`void`	`reject(String errorCode, Map<String,Object> messageVariables)` グローバルエラーを登録する。
`void`	`reject(String errorCode, Map<String,Object> messageVariables, String defaultMessage)` グローバルエラーを登録する。
`void`	`reject(String errorCode, String defaultMessage)` グローバルエラーを登録する。
`void`	`rejectValue(String field, Class<?> fieldType, String[] errorCodes, Map<String,Object> messageVariables, String defaultMessage)` フィールドエラーを登録します。
`void`	`rejectValue(String field, Class<?> fieldType, String errorCode, Map<String,Object> messageVariables)` フィールドエラーを登録します。
`void`	`rejectValue(String field, Class<?> fieldType, String errorCode, Map<String,Object> messageVariables, String defaultMessage)` フィールドエラーを登録します。
`void`	`rejectValue(String field, String errorCode)` フィールドエラーを登録します。
`void`	`rejectValue(String field, String errorCode, Map<String,Object> messageVariables, String defaultMessage)` フィールドエラーを登録します。
`void`	`rejectValue(String field, String errorCode, String defaultMessage)` フィールドエラーを登録します。
`void`	`setMessageCodeGenerator(MessageCodeGenerator messageCodeGenerator)`

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

- フィールドの詳細
  - PATH_SEPARATOR
```
public static final String PATH_SEPARATOR
```
    パスの区切り文字
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - CsvBindingErrors
```
public CsvBindingErrors(String objectName)
```
    オブジェクト名を指定するコンストラクタ。
    
    パラメータ:
    
    objectName - メッセージオブジェクトを構成する際に、自動的に付与する名称。
    
    例外:
    
    NullPointerException - is null.
  - CsvBindingErrors
```
public CsvBindingErrors(Class<?> clazz)
```
    クラス名を元にオブジェクト名を設定するコンストラクタ。
    
    パラメータ:
    
    clazz - 検証対象のBeanのクラスタイプ。
- メソッドの詳細
  - getObjectName
```
public String getObjectName()
```
    オブジェクト名の取得
    
    戻り値:
    
    コンストラクタで設定したオブジェクト名を取得する。
  - getAllErrors
```
public List<CsvError> getAllErrors()
```
    全てのエラー情報を取得する。
    
    戻り値:
    
    現在のエラー情報
  - addError
```
public void addError(CsvError error)
```
    エラーを追加する
    
    パラメータ:
    
    error -
  - addAllErrors
```
public void addAllErrors(Collection<CsvError> errors)
```
    全てのエラー情報を追加する。
    
    パラメータ:
    
    errors - 追加するエラー情報。
  - clearAllErrors
```
public void clearAllErrors()
```
    全てのエラー情報を削除する。
  - hasErrors
```
public boolean hasErrors()
```
    エラー情報が存在するかどうか確かめる。
    
    戻り値:
    
    trueの場合、エラー情報が存在する。
  - getGlobalErrors
```
public List<CsvError> getGlobalErrors()
```
    グローバルエラーを取得する
    
    戻り値:
    
    エラーがない場合は空のリストを返す
  - getFirstGlobalError
```
public CsvError getFirstGlobalError()
```
    先頭のグローバルエラーを取得する。
    
    戻り値:
    
    存在しない場合は、nullを返す。
  - hasGlobalErrors
```
public boolean hasGlobalErrors()
```
    グローバルエラーがあるか確かめる。
    
    戻り値:
  - getGlobalErrorCount
```
public int getGlobalErrorCount()
```
    グローバルエラーの件数を取得する
    
    戻り値:
  - getFieldErrors
```
public List<CsvFieldError> getFieldErrors()
```
    フィールドエラーを取得する
    
    戻り値:
    
    エラーがない場合は空のリストを返す
  - getFirstFieldError
```
public CsvFieldError getFirstFieldError()
```
    先頭のフィールドエラーを取得する
    
    戻り値:
    
    エラーがない場合は空のリストを返す
  - hasFieldErrors
```
public boolean hasFieldErrors()
```
    フィールドエラーが存在するか確かめる。
    
    戻り値:
    
    true:フィールドエラーを持つ。
  - getFieldErrorCount
```
public int getFieldErrorCount()
```
    フィールドエラーの件数を取得する。
    
    戻り値:
  - getFieldErrors
```
public List<CsvFieldError> getFieldErrors(String path)
```
    パスを指定してフィールドエラーを取得する
    
    パラメータ:
    
    path - 最後に'*'を付けるとワイルドカードが指定可能。
    
    戻り値:
    
    例外:
    
    IllegalArgumentException - if path is empty.
  - getFirstFieldError
```
public CsvFieldError getFirstFieldError(String path)
```
    パスを指定して先頭のフィールドエラーを取得する
    
    パラメータ:
    
    path - 最後に'*'を付けるとワイルドカードが指定可能。
    
    戻り値:
    
    エラーがない場合は空のリストを返す
  - hasFieldErrors
```
public boolean hasFieldErrors(String path)
```
    指定したパスのフィィールドエラーが存在するか確かめる。
    
    パラメータ:
    
    path - 最後に'*'を付けるとワイルドカードが指定可能。
    
    戻り値:
    
    true:エラーがある場合。
  - getFieldErrorCount
```
public int getFieldErrorCount(String path)
```
    指定したパスのフィィールドエラーの件数を取得する。
    
    パラメータ:
    
    path - 最後に'*'を付けるとワイルドカードが指定可能。
    
    戻り値:
  - reject
```
public void reject(String errorCode)
```
    グローバルエラーを登録する。
    
    パラメータ:
    
    errorCode - エラーコード
  - reject
```
public void reject(String errorCode,
                   String defaultMessage)
```
    グローバルエラーを登録する。
    
    パラメータ:
    
    errorCode - エラーコード
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
  - reject
```
public void reject(String errorCode,
                   Map<String,Object> messageVariables)
```
    グローバルエラーを登録する。
    
    パラメータ:
    
    errorCode - エラーコード
    
    messageVariables - メッセージ中の変数。
  - reject
```
public void reject(String errorCode,
                   Map<String,Object> messageVariables,
                   String defaultMessage)
```
    グローバルエラーを登録する。
    
    パラメータ:
    
    errorCode - エラーコード
    
    messageVariables - メッセージ中の変数。
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
  - reject
```
public void reject(String[] errorCodes,
                   Map<String,Object> messageVariables,
                   String defaultMessage)
```
    グローバルエラーを登録する。
    
    パラメータ:
    
    errorCodes - エラーコード
    
    messageVariables - メッセージ中の変数。
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
    
    導入されたバージョン:
    
    2.2
  - rejectValue
```
public void rejectValue(String field,
                        String errorCode)
```
    フィールドエラーを登録します。
    
    パラメータ:
    
    field - フィールドパス。
    
    errorCode - エラーコード。
  - rejectValue
```
public void rejectValue(String field,
                        String errorCode,
                        String defaultMessage)
```
    フィールドエラーを登録します。
    
    パラメータ:
    
    field - フィールドパス。
    
    errorCode - エラーコード。
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
  - rejectValue
```
public void rejectValue(String field,
                        String errorCode,
                        Map<String,Object> messageVariables,
                        String defaultMessage)
```
    フィールドエラーを登録します。
    
    パラメータ:
    
    field - フィールドパス。
    
    errorCode - エラーコード。
    
    messageVariables - メッセージ中の変数。
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
  - rejectValue
```
public void rejectValue(String field,
                        Class<?> fieldType,
                        String errorCode,
                        Map<String,Object> messageVariables)
```
    フィールドエラーを登録します。
    
    パラメータ:
    
    field - フィールドパス。
    
    fieldType - フィールドのタイプ
    
    errorCode - エラーコード。
    
    messageVariables - メッセージ中の変数。
  - rejectValue
```
public void rejectValue(String field,
                        Class<?> fieldType,
                        String errorCode,
                        Map<String,Object> messageVariables,
                        String defaultMessage)
```
    フィールドエラーを登録します。
    
    パラメータ:
    
    field - フィールドパス。
    
    fieldType - フィールドのタイプ
    
    errorCode - エラーコード。
    
    messageVariables - メッセージ中の変数。
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
  - rejectValue
```
public void rejectValue(String field,
                        Class<?> fieldType,
                        String[] errorCodes,
                        Map<String,Object> messageVariables,
                        String defaultMessage)
```
    フィールドエラーを登録します。
    
    パラメータ:
    
    field - フィールドパス。
    
    fieldType - フィールドのタイプ
    
    errorCodes - エラーコード。
    
    messageVariables - メッセージ中の変数。
    
    defaultMessage - 指定したエラーコードに対するメッセージが見つからないときに使用するメッセージです。指定しない場合はnullを設定します。
    
    導入されたバージョン:
    
    2.2
  - getMessageCodeGenerator
```
public MessageCodeGenerator getMessageCodeGenerator()
```
  - setMessageCodeGenerator
```
public void setMessageCodeGenerator(MessageCodeGenerator messageCodeGenerator)
```

クラス CsvBindingErrors

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

PATH_SEPARATOR

コンストラクタの詳細

CsvBindingErrors

CsvBindingErrors

メソッドの詳細

getObjectName

getAllErrors

addError

addAllErrors

clearAllErrors

hasErrors

getGlobalErrors

getFirstGlobalError

hasGlobalErrors

getGlobalErrorCount

getFieldErrors

getFirstFieldError

hasFieldErrors

getFieldErrorCount

getFieldErrors

getFirstFieldError

hasFieldErrors

getFieldErrorCount

reject

reject

reject

reject

reject

rejectValue

rejectValue

rejectValue

rejectValue

rejectValue

rejectValue

getMessageCodeGenerator

setMessageCodeGenerator