Package 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>, java.lang.constant.Constable
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 Details

  • Method Details

    • values

      public static EExchangeFileType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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)