com.adaptris.core.wmq

Enum MQMessageFactory.MQMessageInstance

java.lang.Object

java.lang.Enum<MQMessageFactory.MQMessageInstance>

com.adaptris.core.wmq.MQMessageFactory.MQMessageInstance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MQMessageFactory.MQMessageInstance>

Enclosing class:

MQMessageFactory

public static enum MQMessageFactory.MQMessageInstance
extends java.lang.Enum<MQMessageFactory.MQMessageInstance>

Types of MQMEssage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Bytes A Bytes Message.
Object An Object Message.
String A String Message.
Text A Text (UTF-8) Message.

Method Summary

Modifier and Type	Method and Description
abstract com.ibm.mq.MQMessage	create() Create an MQMessage object.
static MQMessageFactory.MQMessageInstance	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MQMessageFactory.MQMessageInstance[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract void	write(AdaptrisMessage msg, com.ibm.mq.MQMessage mqMsg) Write the contents of the AdaptrisMessage object to the MQMessage object.
abstract void	write(com.ibm.mq.MQMessage mqMsg, AdaptrisMessage msg) Write the contents of the MQMessage object to the AdaptrisMessage object.

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

Text

public static final MQMessageFactory.MQMessageInstance Text

A Text (UTF-8) Message.

String

public static final MQMessageFactory.MQMessageInstance String

A String Message.

Bytes

public static final MQMessageFactory.MQMessageInstance Bytes

A Bytes Message.

Object

public static final MQMessageFactory.MQMessageInstance Object

An Object Message.

Method Detail

values

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

Returns:

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

valueOf

public static MQMessageFactory.MQMessageInstance 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

create

public abstract com.ibm.mq.MQMessage create()

Create an MQMessage object.

Returns:

an MQMessage

write

public abstract void write(AdaptrisMessage msg,
                           com.ibm.mq.MQMessage mqMsg)
                    throws java.io.IOException,
                           com.ibm.mq.MQException

Write the contents of the AdaptrisMessage object to the MQMessage object.

Parameters:

msg - the AdaptrisMessage Object

mqMsg - the MQMessage Object

Throws:

java.io.IOException - when writing to the buffer

com.ibm.mq.MQException - upon MQ communication errors.

write

public abstract void write(com.ibm.mq.MQMessage mqMsg,
                           AdaptrisMessage msg)
                    throws java.io.IOException,
                           com.ibm.mq.MQException

Write the contents of the MQMessage object to the AdaptrisMessage object.

Parameters:

msg - the AdaptrisMessage Object

mqMsg - the MQMessage Object

Throws:

java.io.IOException - when writing to the buffer

com.ibm.mq.MQException - upon MQ communication errors.