CsvEntity.java

/*
 * Copyright 2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.orangesignal.csv.annotation;

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

/**
 * 区切り文字形式のデータであることを示します。
 *
 * @author Koji Sugisawa
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface CsvEntity {

	/**
	 * 区切り文字形式データの列見出し (ヘッダ) 行を使用するかどうかを返します。<p>
	 * 区切り文字形式データの列見出し (ヘッダ) 行を使用しないとした場合、先頭行は列見出し (ヘッダ) 行ではなくデータ行として処理されます。
	 *
	 * @return 区切り文字形式データの列見出し (ヘッダ) 行を使用するかどうか
	 */
	boolean header() default true;

}