ca.uhn.hl7v2.hoh.encoder

Enum EncodingStyle

java.lang.Object

java.lang.Enum<EncodingStyle>

ca.uhn.hl7v2.hoh.encoder.EncodingStyle

All Implemented Interfaces:

Serializable, Comparable<EncodingStyle>

public enum EncodingStyle
extends Enum<EncodingStyle>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ER7 ER7 (Pipe and Hat, or Vertical Bar encoding)
XML XML encoding

Method Summary

Modifier and Type	Method and Description
static EncodingStyle	detect(String theMessage) Detect the encoding style of a given message
String	getContentType() Returns the MIME type (content-type) associated with this encoding
static EncodingStyle	getEncodingStyleForContentType(String theContentType) Returns the encoding style (e.g.
static EncodingStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static EncodingStyle[]	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

ER7

public static final EncodingStyle ER7

ER7 (Pipe and Hat, or Vertical Bar encoding)

Content type: application/hl7-v2

XML

public static final EncodingStyle XML

XML encoding

Content type: application/hl7-v2+xml

Method Detail

values

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

Returns:

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

valueOf

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

getEncodingStyleForContentType

public static EncodingStyle getEncodingStyleForContentType(String theContentType)

Returns the encoding style (e.g. ER7) for a given content type (e.g. application/hl7-v2), or null if content type does not match an HL7 definition.

Parameters:

theContentType - The content type (case insensitive)

Returns:

Returns null if no matching

Throws:

NullPointerException - If theContentType is null

detect

public static EncodingStyle detect(String theMessage)

Detect the encoding style of a given message

Throws:

NullPointerException - If theMessage is null

IllegalArgumentException - If the message is not ER7 or XML

getContentType

public String getContentType()

Returns the MIME type (content-type) associated with this encoding