ca.uhn.hl7v2.hoh.api

Enum MessageMetadataKeys

java.lang.Object

java.lang.Enum<MessageMetadataKeys>

ca.uhn.hl7v2.hoh.api.MessageMetadataKeys

All Implemented Interfaces:

Serializable, Comparable<MessageMetadataKeys>

public enum MessageMetadataKeys
extends Enum<MessageMetadataKeys>

Enum containing keys for message metadata

Enum Constant Summary

Enum Constants

Enum Constant and Description
REMOTE_HOST_ADDRESS The host address from which the message was sent.

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getValueType()
static Set<String>	keyStringSet()
static MessageMetadataKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageMetadataKeys[]	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

REMOTE_HOST_ADDRESS

public static final MessageMetadataKeys REMOTE_HOST_ADDRESS

The host address from which the message was sent. Value will be a String containing a raw IP address.

See Also:

ServletRequest.getRemoteAddr()

Method Detail

values

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

Returns:

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

valueOf

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

getValueType

public Class<?> getValueType()

Returns:

The type for the value which is associated with this key

keyStringSet

public static Set<String> keyStringSet()

Returns:

Returns a set containing the string equivalent to all entries in the map