com.ibm.mq.pcf

Class MQCFSL

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

All Implemented Interfaces:

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

public class MQCFSL
extends PCFParameter

MQCFSL (PCF string list parameter) header class.

        struct tagMQCFSL {
                MQLONG  Type;            // Structure type
                MQLONG  StrucLength;     // Structure length
                MQLONG  Parameter;       // Parameter identifier
                MQLONG  CodedCharSetId;  // Coded character set identifier
                MQLONG  Count;           // Count of parameter values
                MQLONG  StringLength;    // Length of one string
                MQCHAR  Strings[1];      // String values -- first character
        };
 

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	codedCharSetId coded character set identifier
int	count count of parameter values
int	parameter parameter identifier
int	stringLength length of one string
java.lang.String[]	strings string values
int	strucLength structure length (fixed portion)
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

Constructor Summary

Constructors

Constructor and Description
MQCFSL() Constructs an MQCFSL instance with default field values.
MQCFSL(java.io.DataInput message, int encoding, int characterSet) Constructs an MQCFSL instance populated from a DataInput source.
MQCFSL(int parameter, java.lang.String[] strings) Initializes an MQCFSL with the specified values.
MQCFSL(MQMessage message) Constructs an MQCFSL 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 MQCFSL instance with the same parameter and equivalent set of values in the same order.
int	getCodedCharSetId() gets the coded character set identifier
int	getCount() gets the count of parameter values
int	getParameter() gets the parameter identifier
int	getStringLength() gets the length of one string (all are the same length)
java.lang.String[]	getStrings() gets the string values
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	setCodedCharSetId(int value) set the coded character set identifier
void	setParameter(int value) sets the parameter identifier
void	setStrings(java.lang.String[] value) sets the string values

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

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

type

public static final int type

structure type

See Also:

Constant Field Values

strucLength

public int strucLength

structure length (fixed portion)

parameter

public int parameter

parameter identifier

codedCharSetId

public int codedCharSetId

coded character set identifier

count

public int count

count of parameter values

stringLength

public int stringLength

length of one string

strings

public java.lang.String[] strings

string values

Constructor Detail

MQCFSL

public MQCFSL()

Constructs an MQCFSL instance with default field values.

MQCFSL

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

Constructs an MQCFSL instance populated from an MQMessage.

Parameters:

message - the message to read

Throws:

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

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

MQCFSL

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

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

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

MQCFSL

public MQCFSL(int parameter,
      java.lang.String[] strings)

Initializes an MQCFSL with the specified values.

Parameters:

parameter - the parameter identifier

strings - the set of string values

Method Detail

equals

public boolean equals(java.lang.Object obj)

Returns true when invoked with another MQCFSL instance with the same parameter and equivalent set of values in the same order. Comparison of the values is performed using String.equals. Note: Two MQCFSL instances with null values sets are not regarded as equal.
It doesn't really matter - such instances are not really interesting - but it's worth commenting on.

Overrides:

equals in class PCFParameter

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

Specified by:

hashCode in class PCFParameter

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

getCodedCharSetId

public int getCodedCharSetId()

gets the coded character set identifier

Returns:

the coded character set identifier

setCodedCharSetId

public void setCodedCharSetId(int value)

set the coded character set identifier

Parameters:

value - the coded character set identifier

getCount

public int getCount()

gets the count of parameter values

Returns:

the count of parameter values

getStringLength

public int getStringLength()

gets the length of one string (all are the same length)

Returns:

the length of one string

getStrings

public java.lang.String[] getStrings()

gets the string values

Returns:

the string values

setStrings

public void setStrings(java.lang.String[] value)

sets the string values

Parameters:

value - the string 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

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()