com.helger.photon.exchange

Enum EExchangeFileType

java.lang.Object

java.lang.Enum<EExchangeFileType>

com.helger.photon.exchange.EExchangeFileType

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.text.display.IHasDisplayText, Serializable, Comparable<EExchangeFileType>

public enum EExchangeFileType
extends Enum<EExchangeFileType>
implements com.helger.commons.id.IHasID<String>, com.helger.commons.text.display.IHasDisplayText

Defines common file types for import/export.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
CSV
JSON
JSON_SIMPLE
TXT
XLS
XLSX
XML

Method Summary

Modifier and Type	Method and Description
abstract IExporter	createExporter()
String	getDisplayText(Locale aContentLocale)
String	getExportAsText(Locale aContentLocale)
String	getFileExtension()
static EExchangeFileType	getFromIDOrDefault(String sID, EExchangeFileType eDefault)
static EExchangeFileType	getFromIDOrNull(String sID)
String	getID()
com.helger.commons.mime.IMimeType	getMimeType()
String	getSaveAsText(Locale aContentLocale)
boolean	isExporterAvailable()
boolean	isLineBased()
static EExchangeFileType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EExchangeFileType[]	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

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getAsHasText, getComparatorCollating

Enum Constant Detail

CSV

public static final EExchangeFileType CSV

XLS

public static final EExchangeFileType XLS

XLSX

public static final EExchangeFileType XLSX

XML

public static final EExchangeFileType XML

TXT

public static final EExchangeFileType TXT

JSON

public static final EExchangeFileType JSON

JSON_SIMPLE

public static final EExchangeFileType JSON_SIMPLE

Method Detail

values

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

Returns:

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

valueOf

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

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getFileExtension

@Nonnull
 @Nonempty
public String getFileExtension()

Returns:

The desired file extension including the leading dot.

getMimeType

@Nonnull
public com.helger.commons.mime.IMimeType getMimeType()

Returns:

The MIMe type for created files.

isLineBased

public boolean isLineBased()

Returns:

true if this file type is line based. This is e.g. the case for CSV or Excel files.

getDisplayText

@Nullable
public String getDisplayText(@Nonnull
                                        Locale aContentLocale)

Specified by:

getDisplayText in interface com.helger.commons.text.display.IHasDisplayText

getExportAsText

@Nullable
public String getExportAsText(@Nonnull
                                         Locale aContentLocale)

getSaveAsText

@Nullable
public String getSaveAsText(@Nonnull
                                       Locale aContentLocale)

createExporter

@Nullable
public abstract IExporter createExporter()

isExporterAvailable

public boolean isExporterAvailable()

getFromIDOrNull

@Nullable
public static EExchangeFileType getFromIDOrNull(@Nullable
                                                           String sID)

getFromIDOrDefault

@Nullable
public static EExchangeFileType getFromIDOrDefault(@Nullable
                                                              String sID,
                                                              @Nullable
                                                              EExchangeFileType eDefault)