io.github.relbraun.poi.ss.model.annotations.Sheet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of poi-object-mapper Show documentation

Objects mapper for Office formats - Excel files, Spreadsheets, etc.

The newest version!

package io.github.relbraun.poi.ss.model.annotations;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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


/**
 * Marker annotation that can be used to define a "type" for a sheet. The value of this annotation
 * will be used to map the sheet of the workbook to this bean definition.
 * 
 * 
 * Default value ("") indicates that the default sheet name to be used without any modifications,
 * but it can be specified to non-empty value to specify different name.
 * 
 * 
 * 
 * Typically used when writing the java objects to the file.
 * 
 */
@Retention(RUNTIME)
@Target(TYPE)
public @interface Sheet {

    /**
     * Name of the sheet.
     * @return the Sheet name
     */
    String value() default "";

}