Package ca.uhn.fhir.rest.api

Enum Class EncodingEnum

java.lang.Object

java.lang.Enum<EncodingEnum>

ca.uhn.fhir.rest.api.EncodingEnum

All Implemented Interfaces:

Serializable, Comparable<EncodingEnum>, Constable

public enum EncodingEnum
extends Enum<EncodingEnum>

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
JSON
NDJSON
RDF
XML

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PLAIN_STRING	"json"
static final String	NDJSON_PLAIN_STRING	"ndjson"
static final String	RDF_PLAIN_STRING	"rdf"
static final String	XML_PLAIN_STRING	"xml"

Method Summary

Modifier and Type	Method	Description
static EncodingEnum	detectEncoding(String theBody)
static EncodingEnum	detectEncodingNoDefault(String theBody)
static EncodingEnum	forContentType(String theContentType)	Returns the encoding for a given content type, or null if no encoding is found.
static EncodingEnum	forContentTypeStrict(String theContentType)	Returns the encoding for a given content type, or null if no encoding is found.
String	getFormatContentType()	Returns xml or json as used on the _format search parameter
String	getResourceContentType()	Will return application/xml+fhir style
String	getResourceContentTypeNonLegacy()	Will return application/fhir+xml style
static boolean	isLegacy(String theContentType)	Is the given type a FHIR legacy (pre-DSTU3) content type?
abstract IParser	newParser(FhirContext theContext)
static EncodingEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EncodingEnum[]	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

JSON

public static final EncodingEnum JSON

XML

public static final EncodingEnum XML

RDF

public static final EncodingEnum RDF

NDJSON

public static final EncodingEnum NDJSON

Field Details

JSON_PLAIN_STRING

public static final String JSON_PLAIN_STRING

"json"

See Also:

• Constant Field Values

RDF_PLAIN_STRING

public static final String RDF_PLAIN_STRING

"rdf"

See Also:

• Constant Field Values

XML_PLAIN_STRING

public static final String XML_PLAIN_STRING

"xml"

See Also:

• Constant Field Values

NDJSON_PLAIN_STRING

public static final String NDJSON_PLAIN_STRING

"ndjson"

See Also:

• Constant Field Values

Method Details

values

public static EncodingEnum[] 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 EncodingEnum 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

getFormatContentType

public String getFormatContentType()

Returns xml or json as used on the _format search parameter

getResourceContentType

public String getResourceContentType()

Will return application/xml+fhir style

getResourceContentTypeNonLegacy

public String getResourceContentTypeNonLegacy()

Will return application/fhir+xml style

newParser

public abstract IParser newParser(FhirContext theContext)

detectEncoding

public static EncodingEnum detectEncoding(String theBody)

detectEncodingNoDefault

public static EncodingEnum detectEncodingNoDefault(String theBody)

forContentType

public static EncodingEnum forContentType(String theContentType)

Returns the encoding for a given content type, or null if no encoding is found.

This method is lenient! Things like "application/xml" will return XML even if the "+fhir" part is missing from the expected content type. Also, spaces are treated as a plus (i.e. "application/fhir json" will be treated as "application/fhir+json" in order to account for unescaped spaces in URL parameters)

forContentTypeStrict

public static EncodingEnum forContentTypeStrict(String theContentType)

Returns the encoding for a given content type, or null if no encoding is found.

This method is NOT lenient! Things like "application/xml" will return null

See Also:

• forContentType(String)

isLegacy

public static boolean isLegacy(String theContentType)

Is the given type a FHIR legacy (pre-DSTU3) content type?