com.adaptris.core.wmq.mapping

Enum FieldMapper.Field

java.lang.Object

java.lang.Enum<FieldMapper.Field>

com.adaptris.core.wmq.mapping.FieldMapper.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FieldMapper.Field>

Enclosing class:

FieldMapper

public static enum FieldMapper.Field
extends java.lang.Enum<FieldMapper.Field>

Fields within a MQMessage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
accountingToken
applicationIdData
applicationOriginData
backoutCount
characterSet
correlationId
encoding
expiry
feedback
format
groupId
messageFlags
messageId
messageSequenceNumber
messageType
offset
originalLength
persistence
priority
putApplicationName
putApplicationType
putDateTime
replyToQueueManagerName
replyToQueueName
report
userId
version

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_BYTE_TRANSLATOR_ERROR

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getMqField(com.ibm.mq.MQMessage msg, ByteTranslator c) Get the MQMessage field and return it as a String.
abstract void	setMqField(com.ibm.mq.MQMessage msg, java.lang.String value, ByteTranslator c) Map the value onto the specific mq-field.
static FieldMapper.Field	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FieldMapper.Field[]	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

accountingToken

public static final FieldMapper.Field accountingToken

applicationIdData

public static final FieldMapper.Field applicationIdData

applicationOriginData

public static final FieldMapper.Field applicationOriginData

backoutCount

public static final FieldMapper.Field backoutCount

characterSet

public static final FieldMapper.Field characterSet

correlationId

public static final FieldMapper.Field correlationId

encoding

public static final FieldMapper.Field encoding

expiry

public static final FieldMapper.Field expiry

feedback

public static final FieldMapper.Field feedback

format

public static final FieldMapper.Field format

groupId

public static final FieldMapper.Field groupId

messageFlags

public static final FieldMapper.Field messageFlags

messageId

public static final FieldMapper.Field messageId

messageSequenceNumber

public static final FieldMapper.Field messageSequenceNumber

messageType

public static final FieldMapper.Field messageType

offset

public static final FieldMapper.Field offset

originalLength

public static final FieldMapper.Field originalLength

persistence

public static final FieldMapper.Field persistence

priority

public static final FieldMapper.Field priority

putApplicationName

public static final FieldMapper.Field putApplicationName

putApplicationType

public static final FieldMapper.Field putApplicationType

putDateTime

public static final FieldMapper.Field putDateTime

replyToQueueManagerName

public static final FieldMapper.Field replyToQueueManagerName

replyToQueueName

public static final FieldMapper.Field replyToQueueName

report

public static final FieldMapper.Field report

userId

public static final FieldMapper.Field userId

version

public static final FieldMapper.Field version

Field Detail

NO_BYTE_TRANSLATOR_ERROR

public static final java.lang.String NO_BYTE_TRANSLATOR_ERROR

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static FieldMapper.Field 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

setMqField

public abstract void setMqField(com.ibm.mq.MQMessage msg,
                                java.lang.String value,
                                ByteTranslator c)
                         throws java.io.IOException

Map the value onto the specific mq-field.

Parameters:

msg - the MQMessage whose fields need to be modified

value - the value

c - the byte translator, if appropriate

Throws:

java.io.IOException - on error translating the fields.

getMqField

public abstract java.lang.String getMqField(com.ibm.mq.MQMessage msg,
                                            ByteTranslator c)
                                     throws java.io.IOException

Get the MQMessage field and return it as a String.

Parameters:

msg - the MQMessage

c - the byte translator to be used if appropriate

Returns:

the string representing the field.

Throws:

java.io.IOException - on error translating the fields.