com.github.mygreen.supercsv.builder

クラス FieldAccessor

java.lang.Object

com.github.mygreen.supercsv.builder.FieldAccessor

public class FieldAccessor
extends Object

フィールドに統一的にアクセスするためのクラス。

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

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

コンストラクタ

コンストラクタと説明
FieldAccessor(Field field, Comparator<Annotation> comparator) フィールド情報を指定するコンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<A extends Annotation> Optional<A>	getAnnotation(Class<A> annoClass) アノテーションのタイプを指定してアノテーションを取得します。
<A extends Annotation> List<A>	getAnnotations(Class<A> annoClass) アノテーションのタイプを指定してアノテーション一覧を取得します。
List<Annotation>	getAnnotationsByGroup(Class<?>... groups) 付与されているアノテーションの一覧を取得する。
<A extends Annotation> List<A>	getAnnotationsByGroup(Class<A> annoClass, Class<?>... groups) アノテーションのタイプとグループを指定してアノテーションを取得します。
Class<?>	getDeclaredClass() フィールドが定義されているクラス情報を取得する。
String	getName() フィールドの名称を取得する。
String	getNameWithClass() クラス名付きのフィールド名称を取得する。
Class<?>	getType() フィールドのタイプを取得する。
String	getTypeName() フィールドのタイプのクラス名称を取得する。
Object	getValue(Object record) フィールドの値を取得する。
<A extends Annotation> boolean	hasAnnotation(Class<A> annoClass) 指定したアノテーションと持つかどうか。
<A extends Annotation> boolean	hasAnnotationByGroup(Class<A> annoClass, Class<?>... groups) グループを指定して指定したアノテーションを持つかどうか判定します。
boolean	isTypeOf(Class<?> clazz) フィールドのタイプが指定してたタイプかどうか。

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

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

コンストラクタの詳細

FieldAccessor

public FieldAccessor(Field field,
                     Comparator<Annotation> comparator)

フィールド情報を指定するコンストラクタ。

パラメータ:

field - フィールド情報

comparator - アノテーションの順序を比較するためのコンパレータ。

例外:

NullPointerException - field or comparator == null.

メソッドの詳細

getAnnotation

public <A extends Annotation> Optional<A> getAnnotation(Class<A> annoClass)

アノテーションのタイプを指定してアノテーションを取得します。

繰り返しのアノテーションの場合、初めに見つかったものを返します。

型パラメータ:

A - 取得対象のアノテーションのタイプ

パラメータ:

annoClass - 取得対象のアノテーションのタイプ。

戻り値:

指定したアノテーションが見つからない場合は、空を返します。

例外:

NullPointerException - annoClass is null.

getAnnotations

public <A extends Annotation> List<A> getAnnotations(Class<A> annoClass)

アノテーションのタイプを指定してアノテーション一覧を取得します。

繰り返しのアノテーションの場合、初めに見つかったものを返します。

型パラメータ:

A - 取得対象のアノテーションのタイプ

パラメータ:

annoClass - 取得対象のアノテーションのタイプ。

戻り値:

指定したアノテーションが見つからない場合は、空のリスト返します。

例外:

NullPointerException - annoClass is null.

hasAnnotation

public <A extends Annotation> boolean hasAnnotation(Class<A> annoClass)

指定したアノテーションと持つかどうか。

繰り返し可能なアノテーションの場合、初めに見つかったものを返します。

型パラメータ:

A - 取得対象のアノテーションのタイプ

パラメータ:

annoClass - 取得対象のアノテーションのタイプ。

戻り値:

trueの場合、アノテーションを持ちます。

例外:

NullPointerException - annoClass is null.

getAnnotationsByGroup

public <A extends Annotation> List<A> getAnnotationsByGroup(Class<A> annoClass,
                                                            Class<?>... groups)

アノテーションのタイプとグループを指定してアノテーションを取得します。

型パラメータ:

A - 取得対象のアノテーションのタイプ

パラメータ:

annoClass - 取得対象のアノテーションのタイプ。

groups - グループ（クラスタイプ）による絞り込み。属性groupsが存在する場合に、絞り込みます。

戻り値:

指定したアノテーションが見つからない場合は、サイズ0のリストを返します。

例外:

NullPointerException - annoClass is null.

hasAnnotationByGroup

public <A extends Annotation> boolean hasAnnotationByGroup(Class<A> annoClass,
                                                           Class<?>... groups)

グループを指定して指定したアノテーションを持つかどうか判定します。

型パラメータ:

A - 取得対象のアノテーションのタイプ

パラメータ:

annoClass - 判定対象のアノテーションのグループ

groups - グループ（クラスタイプ）による絞り込み。属性groupsが存在する場合に、絞り込みます。

戻り値:

指定したアノテーションが見つからない場合は、サイズ0のリストを返します。

getAnnotationsByGroup

public List<Annotation> getAnnotationsByGroup(Class<?>... groups)

付与されているアノテーションの一覧を取得する。

パラメータ:

groups - グループ（クラスタイプ）による絞り込み。属性groupsが存在する場合に、絞り込みます。

戻り値:

指定したアノテーションが見つからない場合は、サイズ0のリストを返します。

getName

public String getName()

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

戻り値:

フィールド名

getNameWithClass

public String getNameWithClass()

クラス名付きのフィールド名称を取得する。

戻り値:

<クラス名#フィールド名>の形式

getType

public Class<?> getType()

フィールドのタイプを取得する。

戻り値:

フィールドのクラスタイプ。

getTypeName

public String getTypeName()

フィールドのタイプのクラス名称を取得する。

戻り値:

パッケージ名付きのFQDNの形式。

getDeclaredClass

public Class<?> getDeclaredClass()

フィールドが定義されているクラス情報を取得する。

戻り値:

フィールドが定義されているクラス上方。

関連項目:

Field.getDeclaringClass()

isTypeOf

public boolean isTypeOf(Class<?> clazz)

フィールドのタイプが指定してたタイプかどうか。

Class.isAssignableFrom(Class)により比較を行う。

パラメータ:

clazz - 比較対象のクラスタイプ。

戻り値:

タイプが一致する場合、trueを返す。

getValue

public Object getValue(Object record)

フィールドの値を取得する。

パラメータ:

record - レコードオブジェクト。

戻り値:

フィールドの値。

例外:

IllegalArgumentException - レコードのインスタンスがフィールドが定義されているクラスと異なる場合。

SuperCsvReflectionException - フィールドの値の取得に失敗した場合。