com.marklogic.client.io

Enum Format

java.lang.Object

java.lang.Enum<Format>

com.marklogic.client.io.Format

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Format>

public enum Format
extends java.lang.Enum<Format>

The Format enumerates different kinds of document content.

Enum Constant Summary

Enum Constants

Enum Constant and 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

Modifier and Type	Method and Description
java.lang.String	getDefaultExtension() Returns the default extension for the format.
java.lang.String	getDefaultMimetype() Returns the default mime type for the format.
static Format	getFromDataType(java.lang.String dataType) Returns the format based on a document data type as used in Data Services.
static Format	getFromMimetype(java.lang.String mimeType) Returns the format implied by the mime type
static Format	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Format[]	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

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 Detail

values

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

Returns:

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

valueOf

public static Format valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefaultMimetype

public java.lang.String getDefaultMimetype()

Returns the default mime type for the format.

Returns:

the default mime type

getDefaultExtension

public java.lang.String getDefaultExtension()

Returns the default extension for the format.

Returns:

the default extension

getFromMimetype

public static Format getFromMimetype(java.lang.String mimeType)

Returns the format implied by the mime type

Parameters:

mimeType - the mime type

Returns:

the format

getFromDataType

public static Format getFromDataType(java.lang.String dataType)

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

Parameters:

dataType - the data type

Returns:

the format