Package cdc.issues.io

Enum IssuesFormat

java.lang.Object

java.lang.Enum<IssuesFormat>

cdc.issues.io.IssuesFormat

All Implemented Interfaces:

Serializable, Comparable<IssuesFormat>

public enum IssuesFormat
extends Enum<IssuesFormat>

Enumeration of possible formats for export and import of issues.

A format may be unsupported.

Author:

Damien Carbonne

Enum Constant Summary

Enum Constants

Enum Constant	Description
CSV
JSON
ODS
XLS
XLSM
XLSX
XML

Method Summary

Modifier and Type	Method	Description
static IssuesFormat	from(File file)
cdc.office.ss.WorkbookKind	getWorkbookKind()
boolean	isExportFormat()
boolean	isImportFormat()
static IssuesFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IssuesFormat[]	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

CSV

public static final IssuesFormat CSV

ODS

public static final IssuesFormat ODS

XLS

public static final IssuesFormat XLS

XLSM

public static final IssuesFormat XLSM

XLSX

public static final IssuesFormat XLSX

JSON

public static final IssuesFormat JSON

XML

public static final IssuesFormat XML

Method Detail

values

public static IssuesFormat[] 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 (IssuesFormat c : IssuesFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IssuesFormat 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

getWorkbookKind

public cdc.office.ss.WorkbookKind getWorkbookKind()

Returns:

The corresponding WorkbookKind.

Throws:

cdc.util.lang.UnexpectedValueException - when no corresponding format can be provided.

isExportFormat

public boolean isExportFormat()

Returns:

true if this format is supported for export.

isImportFormat

public boolean isImportFormat()

Returns:

true if this format is supported for import.

from

public static IssuesFormat from(File file)

Parameters:

file - The file.

Returns:

The format associated to file or null.