WorkbookFormat (Asakusa Framework 0.10.4 API)

java.lang.Object
- java.lang.Enum<WorkbookFormat>
- - com.asakusafw.testdata.generator.excel.WorkbookFormat

All Implemented Interfaces:

Serializable, Comparable<WorkbookFormat>
```
public enum WorkbookFormat
extends Enum<WorkbookFormat>
```
Format of workbook.

Since:

0.2.0

Version:

0.5.3

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALL` Input and output data sheet and rule sheet.
`ALLX` Input and output data sheet and rule sheet (Excel 2007).
`DATA` Only data sheet.
`DATAX` Only data sheet (Excel 2007).
`INOUT` Input data sheet and output data sheet.
`INOUTX` Input data sheet and output data sheet (Excel 2007).
`INSPECT` Expected data sheet and rule sheet.
`INSPECTX` Expected data sheet and rule sheet (Excel 2007).
`RULE` Only rule sheet.
`RULEX` Only rule sheet (Excel 2007).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WorkbookFormat`	`findByName(String format)` Returns predefined format by its name.
`String`	`getFileName(ModelDeclaration model)` Returns a simple file name for the model.
`List<SheetFormat>`	`getSheets()` Returns the format of each sheet.
`org.apache.poi.ss.SpreadsheetVersion`	`getVersion()` Returns the target spreadsheet version.
`static WorkbookFormat`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WorkbookFormat[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DATA
```
public static final WorkbookFormat DATA
```
    Only data sheet.
  - RULE
```
public static final WorkbookFormat RULE
```
    Only rule sheet.
  - INOUT
```
public static final WorkbookFormat INOUT
```
    Input data sheet and output data sheet.
  - INSPECT
```
public static final WorkbookFormat INSPECT
```
    Expected data sheet and rule sheet.
  - ALL
```
public static final WorkbookFormat ALL
```
    Input and output data sheet and rule sheet.
  - DATAX
```
public static final WorkbookFormat DATAX
```
    Only data sheet (Excel 2007).
    
    Since:
    
    0.5.3
  - RULEX
```
public static final WorkbookFormat RULEX
```
    Only rule sheet (Excel 2007).
    
    Since:
    
    0.5.3
  - INOUTX
```
public static final WorkbookFormat INOUTX
```
    Input data sheet and output data sheet (Excel 2007).
    
    Since:
    
    0.5.3
  - INSPECTX
```
public static final WorkbookFormat INSPECTX
```
    Expected data sheet and rule sheet (Excel 2007).
    
    Since:
    
    0.5.3
  - ALLX
```
public static final WorkbookFormat ALLX
```
    Input and output data sheet and rule sheet (Excel 2007).
    
    Since:
    
    0.5.3
- Method Detail
  - values
```
public static WorkbookFormat[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (WorkbookFormat c : WorkbookFormat.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static WorkbookFormat valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getVersion
```
public org.apache.poi.ss.SpreadsheetVersion getVersion()
```
    Returns the target spreadsheet version.
    
    Returns:
    
    the version
    
    Since:
    
    0.5.3
  - getSheets
```
public List<SheetFormat> getSheets()
```
    Returns the format of each sheet.
    
    Returns:
    
    the format of each sheet
  - getFileName
```
public String getFileName(ModelDeclaration model)
```
    Returns a simple file name for the model.
    
    Parameters:
    
    model - target model
    
    Returns:
    
    simple file name
    
    Throws:
    
    IllegalArgumentException - if some parameters were null
  - findByName
```
public static WorkbookFormat findByName(String format)
```
    Returns predefined format by its name.
    
    Parameters:
    
    format - the name
    
    Returns:
    
    the corresponded format, or null if not exists
    
    Throws:
    
    IllegalArgumentException - if some parameters were null

Enum WorkbookFormat

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DATA

RULE

INOUT

INSPECT

ALL

DATAX

RULEX

INOUTX

INSPECTX

ALLX

Method Detail

values

valueOf

getVersion

getSheets

getFileName

findByName