com.ibm.mq.pcf

Class MQCFIF

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.PCFFilterParameter

com.ibm.mq.pcf.MQCFIF

All Implemented Interfaces:

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

public class MQCFIF
extends PCFFilterParameter

MQCFIF (PCF integer filter parameter) header class.

        struct tagMQCFIF {
                MQLONG  Type;         // Structure type
                MQLONG  StrucLength;  // Structure length
                MQLONG  Parameter;    // Parameter identifier
                MQLONG  Operator;     // Operator identifier
                MQLONG  FilterValue;  // Filter value
        };
 

Nested Class Summary

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

MQHeader.Field

Field Summary

Fields

Modifier and Type	Field and Description
int	operator operator identifier
int	parameter parameter identifier
static int	SIZE size of the structure in bytes
static int	strucLength structure length
static int	type structure type
int	value filter value

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

Constructor Summary

Constructors

Constructor and Description
MQCFIF() Constructs an MQCFIF instance with default field values.
MQCFIF(java.io.DataInput message, int encoding, int characterSet) Constructs an MQCFIF instance populated from a DataInput source.
MQCFIF(int parameter, int operator, int value) Initializes an MQCFIF header with the specified values.
MQCFIF(MQMessage message) Constructs an MQCFIF instance populated from an MQMessage.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true when invoked with another MQCFIF instance with the same parameter, operator and value.
int	getFilterValue() gets the filter value
int	getOperator() gets the operator identifier
int	getParameter() gets the parameter identifier
java.lang.String	getStringValue() Get the string value of the parameter
int	getStrucLength() Get the length of the structure.
int	getType() gets the structure type
java.lang.Object	getValue() Get the value of the parameter
int	hashCode() Returns a hash code value for the object
void	setFilterValue(int value) sets the filter value
void	setOperator(int value) sets the operator identifier
void	setParameter(int value) sets the parameter identifier

Methods inherited from class com.ibm.mq.pcf.PCFFilterParameter

getHeaderVersion

Methods inherited from class com.ibm.mq.pcf.PCFParameter

getParameterName, 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

SIZE

public static final int SIZE

size of the structure in bytes

See Also:

Constant Field Values

type

public static final int type

structure type

See Also:

Constant Field Values

strucLength

public static final int strucLength

structure length

See Also:

Constant Field Values

parameter

public int parameter

parameter identifier

operator

public int operator

operator identifier

value

public int value

filter value

Constructor Detail

MQCFIF

public MQCFIF()

Constructs an MQCFIF instance with default field values.

MQCFIF

public MQCFIF(MQMessage message)
       throws MQException,
              java.io.IOException

Constructs an MQCFIF instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

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

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

MQCFIF

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

Constructs an MQCFIF 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 MQCFIF stucture

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

MQCFIF

public MQCFIF(int parameter,
      int operator,
      int value)

Initializes an MQCFIF header with the specified values.

Parameters:

parameter - the parameter identifier

operator -

value - the integer parameter value

Method Detail

equals

public boolean equals(java.lang.Object obj)

Returns true when invoked with another MQCFIF instance with the same parameter, operator and value.

Overrides:

equals in class PCFFilterParameter

Parameters:

obj -

Returns:

true of the object equals this one

hashCode

public int hashCode()

Description copied from class: PCFParameter

Returns a hash code value for the object

Overrides:

hashCode in class PCFFilterParameter

Returns:

a hash code value for this object.

See Also:

PCFParameter.hashCode()

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

getOperator

public int getOperator()

gets the operator identifier

Specified by:

getOperator in class PCFFilterParameter

Returns:

the operator identifier

setOperator

public void setOperator(int value)

sets the operator identifier

Parameters:

value - the operator identifier

getFilterValue

public int getFilterValue()

gets the filter value

Returns:

the filter value

setFilterValue

public void setFilterValue(int value)

sets the filter value

Parameters:

value - the filter value

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

See Also:

PCFParameter.getValue()

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

See Also:

PCFParameter.getStringValue()