com.ibm.mq.pcf

Class MQCFBF

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

All implemented interfaces:

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

public class MQCFBF
extends PCFFilterParameter

MQCFBF (PCF byte string filter parameter) header class.

      struct tagMQCFBF {
                MQLONG  Type;               // Structure type
                MQLONG  StrucLength;        // Structure length
                MQLONG  Parameter;          // Parameter identifier
                MQLONG  Operator;           // Operator identifier
                MQLONG  FilterValueLength;  // Filter value length
                MQBYTE  FilterValue[1];     // Filter value -- first byte
        };

Nested Class Summary

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

Field Summary

Modifier and Type	Field and Description
byte[]	`filterValue` filter value
int	`filterValueLength` length of filter value
int	`operator` operator identifier
int	`parameter` parameter identifier
int	`strucLength` structure length
static int	`type` structure type

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
`MQCFBF()` Constructs an MQCFBF instance with default field values.
`MQCFBF(java.io.DataInput message,int encoding,int characterSet)` Constructs an MQCFBF instance populated from a DataInput source.
`MQCFBF(int parameter,int operator,byte[] filterValue)` Initializes an MQCFBF with the specified values.
`MQCFBF(MQMessage message)` Constructs an MQCFBF 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 MQCFBF instance with the same parameter, operator and equivalent value.
byte[]	`getFilterValue()` gets the filter value
int	`getFilterValueLength()` gets the length of the filter value
int	`getOperator()` gets the operator identifier
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()`
void	`setFilterValue(byte[] 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, 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

operator

public int operator

operator identifier

filterValueLength

public int filterValueLength

length of filter value

filterValue

public byte[] filterValue

filter value

Constructor Detail

MQCFBF

public MQCFBF()

Constructs an MQCFBF instance with default field values.

MQCFBF

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

Constructs an MQCFBF instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

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

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

MQCFBF

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

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

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

MQCFBF

public MQCFBF(int parameter,
int operator,
byte[] filterValue)

Initializes an MQCFBF with the specified values.

Parameters:

parameter - the parameter identifier

filterValue - the bytes string filter value

Method Detail

equals

public boolean equals(java.lang.Object obj)

Returns true when invoked with another MQCFBF instance with the same parameter, operator and equivalent value. Comparison of the filter values is performed using java.util.Arrays.equals.

Overrides:

equals in class PCFFilterParameter

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

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

getFilterValueLength

public int getFilterValueLength( )

gets the length of the filter value

Returns:

the length of the filter value

getFilterValue

public byte[] getFilterValue()

gets the filter value

Returns:

the filter value

setFilterValue

public void setFilterValue(byte[] 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

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