com.ibm.mq.pcf

Class MQCFIL

java.lang.Object
com.ibm.mq.jmqi.JmqiObject
com.ibm.mq.headers.internal.Header
com.ibm.mq.pcf.PCFHeader
com.ibm.mq.pcf.PCFParameter
com.ibm.mq.pcf.MQCFIL

All implemented interfaces:

com.ibm.mq.headers.internal.CachingHeader, MQData, MQHeader

public class MQCFIL
extends PCFParameter

MQCFIL (PCF integer list parameter) header class.

        struct tagMQCFIL {
                MQLONG  Type;         // Structure type
                MQLONG  StrucLength;  // Structure length
                MQLONG  Parameter;    // Parameter identifier
                MQLONG  Count;        // Count of parameter values
                MQLONG  Values[1];    // Parameter values -- first element
        };

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader
`MQHeader.Field`

Field Summary

Modifier and Type	Field and Description
int	`count` count of parameter values
int	`parameter` parameter identifier
int	`strucLength` structure length
static int	`type` structure type
int[]	`values` parameter values

Fields inherited from class com.ibm.mq.headers.internal.Header
`DEFAULT_CCSID, DEFAULT_ENCODING`

Fields inherited from class com.ibm.mq.jmqi.JmqiObject
`COMP_JM, COMP_JN, COMP_JO`

Fields inherited from interface com.ibm.mq.headers.internal.CachingHeader
`copyright_notice`

Constructor Summary

Constructor and Description
`MQCFIL()` Constructs an MQCFIL instance with default field values.
`MQCFIL(java.io.DataInput message,int encoding,int characterSet)` Constructs an MQCFIL instance populated from a DataInput source.
`MQCFIL(int parameter,int[] values)` Initializes an MQCFIL with the specified values.
`MQCFIL(MQMessage message)` Constructs an MQCFIL instance populated from an MQMessage.

Method Summary

Modifier and Type	Method and Description
boolean	`equals(java.lang.Object obj)` Returns true when invoked with another MQCFIL instance with the same parameter and equivalent set of values in the same order.
int	`getCount()` gets the count of parameter values
int	`getParameter()` gets the parameter identifier
java.lang.String	`getStringValue()`
int	`getStrucLength()` Get the length of the structure.
int	`getType()` gets the structure type
java.lang.Object	`getValue()`
int[]	`getValues()` gets the parameter values
void	`setParameter(int value)` sets the parameter identifier
void	`setValues(int[] values)` sets the parameter values
static int	`write(MQMessage message,int parameter,int[] values)` A convenience method for writing an MQCFIL header with the specified values to a message.

Methods inherited from class com.ibm.mq.pcf.PCFParameter
`getHeaderVersion, getParameterName, getStore, hashCode, nextParameter`

Methods inherited from class com.ibm.mq.pcf.PCFHeader
`initialize, size, toString, write`

Methods inherited from class com.ibm.mq.headers.internal.Header
`characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, store, store, type, validate, write`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.ibm.mq.headers.internal.CachingHeader
`discardCachedContent, readCachedContent, writeCachedContent`

Field Detail

type

public static final int type

structure type

strucLength

public int strucLength

structure length

parameter

public int parameter

parameter identifier

count

public int count

count of parameter values

values

public int[] values

parameter values

Constructor Detail

MQCFIL

public MQCFIL()

Constructs an MQCFIL instance with default field values.

MQCFIL

public MQCFIL(MQMessage message)
throws MQException
java.io.IOException

Constructs an MQCFIL instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

MQException - if the message content does not yield a valid MQCFIL stucture

java.io.IOException - if there is a problem reading the message content

MQCFIL

public MQCFIL(java.io.DataInput message,
int encoding,
int characterSet)
throws MQException
java.io.IOException

Constructs an MQCFIL instance populated from a DataInput source.

Parameters:

message - the MQMessage or other DataInput source to read

encoding - the initial numeric encoding of the data in the message

characterSet - the initial CCSID of the data in the message

Throws:

MQException - if the message content does not yield a valid MQCFIL stucture

java.io.IOException - if there is a problem reading the message content

MQCFIL

public MQCFIL(int parameter,
int[] values)

Initializes an MQCFIL with the specified values.

Parameters:

parameter - the parameter identifier

values - the set of integer parameter values

Method Detail

write

public static int write(MQMessage message,
int parameter,
int[] values)
throws java.io.IOException

A convenience method for writing an MQCFIL header with the specified values to a message.

Parameters:

message - the message to write to

parameter - the parameter identifier

values - the set of integer values

Returns:

the number of bytes written

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Returns true when invoked with another MQCFIL instance with the same parameter and equivalent set of values in the same order.

Overrides:

equals in class PCFParameter

Parameters:

obj -

Returns:

true of the object equals this one

getType

public int getType()

gets the structure type

Specified by:

getType in class PCFHeader

Returns:

the structure type

getStrucLength

public int getStrucLength()

Get the length of the structure.

Returns:

the structure length.

getParameter

public int getParameter()

gets the parameter identifier

Specified by:

getParameter in class PCFParameter

Returns:

the parameter identifier

setParameter

public void setParameter(int value)

sets the parameter identifier

Parameters:

value - the parameter identifier

getCount

public int getCount()

gets the count of parameter values

Returns:

the count of parameter values

getValues

public int[] getValues()

gets the parameter values

Returns:

the parameter values

setValues

public void setValues(int[] values)

sets the parameter values

Parameters:

values - the parameter values

getValue

public java.lang.Object getValue( )

Description copied from class: PCFParameter

Get the value of the parameter

Specified by:

getValue in class PCFParameter

Returns:

Return the value of the parameter

getStringValue

public java.lang.String getStringValue( )

Description copied from class: PCFParameter

Get the string value of the parameter

Specified by:

getStringValue in class PCFParameter

Returns:

Returns the string value of the parameter