com.gh.mygreen.xlsmapper.annotation.XlsFieldProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xlsmapper Show documentation

XlsMapper is Java Library for mapping Excel sheets to POJO.

The newest version!

package com.gh.mygreen.xlsmapper.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.gh.mygreen.xlsmapper.fieldprocessor.FieldProcessor;
import com.gh.mygreen.xlsmapper.fieldprocessor.FieldProcessorRegistry;

/**
 * マッピング用のアノテーションを表現するためのメタアノテーションです。
 *
 * 
 * // 独自のマッピング用のアノテーションの作成
 * {@literal @Target({ElementType.METHOD, ElementType.FIELD})}
 * {@literal @Retention(RetentionPolicy.RUNTIME)}
 * {@literal @Documented}
 * {@literal @XlsFieldProcessor(SampleFieldProcessor.class)}  // 対応するFieldProcessorの指定
 * public {@literal @interface} XlsSampleAnno {
 *   // ・・・属性の定義
 * }
 * 
 *
 * @since 2.0
 * @author T.TSUCHIE
 *
 */
@Target({ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface XlsFieldProcessor {

    /**
     * アノテーションに対応した{@link FieldProcessor}の実装クラスを指定します。
     * 省略した場合、{@link FieldProcessorRegistry}に登録されているクラスを使用します。
     * @return {@link FieldProcessor}の実装クラス。
     */
    Class>[] value();

}