org.corpus_tools.pepper.modules

Enum PepperExporter.EXPORT_MODE

java.lang.Object

java.lang.Enum<PepperExporter.EXPORT_MODE>

org.corpus_tools.pepper.modules.PepperExporter.EXPORT_MODE

All Implemented Interfaces:

Serializable, Comparable<PepperExporter.EXPORT_MODE>

Enclosing interface:

PepperExporter

public static enum PepperExporter.EXPORT_MODE
extends Enum<PepperExporter.EXPORT_MODE>

Determines how the corpus-structure should be exported.

Author:

Florian Zipser

Enum Constant Summary

Enum Constants

Enum Constant and Description
CORPORA_ONLY SCorpus objects are exported into a folder structure, but SDocument objects are not exported
DOCUMENTS_IN_FILES SCorpus objects are exported into a folder structure and SDocument objects are stored in files having the ending determined by PepperExporter#getDocumentEnding()
NO_EXPORT corpus-structure should not be exported

Method Summary

Modifier and Type	Method and Description
static PepperExporter.EXPORT_MODE	valueOf(String name) Returns the enum constant of this type with the specified name.
static PepperExporter.EXPORT_MODE[]	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

NO_EXPORT

public static final PepperExporter.EXPORT_MODE NO_EXPORT

corpus-structure should not be exported

CORPORA_ONLY

public static final PepperExporter.EXPORT_MODE CORPORA_ONLY

SCorpus objects are exported into a folder structure, but SDocument objects are not exported

DOCUMENTS_IN_FILES

public static final PepperExporter.EXPORT_MODE DOCUMENTS_IN_FILES

SCorpus objects are exported into a folder structure and SDocument objects are stored in files having the ending determined by PepperExporter#getDocumentEnding()

Method Detail

values

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

Returns:

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

valueOf

public static PepperExporter.EXPORT_MODE 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