Enum Class Format

All Implemented Interfaces:

Serializable, Comparable<Format>, Constable

• Nested Class Summary

  Nested classes/interfaces inherited from class java.lang.Enum

  Enum.EnumDesc<E extends Enum<E>>

• Enum Constant Summary

  Enum Constants
  Enum Constant

  Description

  BINARY

  Identifies the format of binary documents such as images.

  JSON

  Identifies the format of JSON documents.

  TEXT

  Identifies the format of text documents such as plain text and HTML.

  UNKNOWN

  Used for documents with unknown or multiple formats.

  XML

  Identifies the format of XML documents such as XHTML.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  String

  getDefaultExtension()

  Returns the default extension for the format.

  String

  getDefaultMimetype()

  Returns the default mime type for the format.

  static Format

  getFromDataType(String dataType)

  Returns the format based on a document data type as used in Data Services.

  static Format

  getFromMimetype(String mimeType)

  Returns the format implied by the mime type

  static Format

  valueOf(String name)

  Returns the enum constant of this class with the specified name.

  static Format[]

  values()

  Returns an array containing the constants of this enum class, in the order they are declared.

  Methods inherited from class java.lang.Enum

  clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

  Methods inherited from class java.lang.Object

  getClass, notify, notifyAll, wait, wait, wait

• Enum Constant Details

  • BINARY

    public static final Format BINARY
    Identifies the format of binary documents such as images.

  • JSON

    public static final Format JSON
    Identifies the format of JSON documents.

  • TEXT

    public static final Format TEXT
    Identifies the format of text documents such as plain text and HTML.

  • XML

    public static final Format XML
    Identifies the format of XML documents such as XHTML.

  • UNKNOWN

    public static final Format UNKNOWN
    Used for documents with unknown or multiple formats.

• Method Details

  • values

    public static Format[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Returns:

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

  • valueOf

    public static Format valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

    NullPointerException - if the argument is null

  • getDefaultMimetype

    public String getDefaultMimetype()
    Returns the default mime type for the format.

    Returns:

    the default mime type

  • getDefaultExtension

    public String getDefaultExtension()
    Returns the default extension for the format.

    Returns:

    the default extension

  • getFromMimetype

    public static Format getFromMimetype(String mimeType)
    Returns the format implied by the mime type

    Parameters:

    mimeType - the mime type

    Returns:

    the format

  • getFromDataType

    public static Format getFromDataType(String dataType)
    Returns the format based on a document data type as used in Data Services.

    Parameters:

    dataType - the data type

    Returns:

    the format

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.