com.ibm.mq.headers.pcf
Class MQCFST
- java.lang.Object
- com.ibm.mq.jmqi.JmqiObject
- com.ibm.mq.headers.internal.Header
- com.ibm.mq.headers.pcf.PCFHeader
- com.ibm.mq.headers.pcf.PCFParameter
- com.ibm.mq.headers.pcf.MQCFST
All implemented interfaces:
- public class MQCFST
- extends PCFParameter
struct tagMQCFST { MQLONG Type; // Structure type MQLONG StrucLength; // Structure length MQLONG Parameter; // Parameter identifier MQLONG CodedCharSetId; // Coded character set identifier MQLONG StringLength; // Length of string MQCHAR String[1]; // String value -- first character };
Nested Class Summary
Nested classes/interfaces inherited from interface com.ibm.mq.headers.MQHeader |
---|
MQHeader.Field |
Field Summary
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
Constructor and Description |
---|
MQCFST()
Constructs an MQCFST instance with default field values.
|
MQCFST(java.io.DataInput message)
Constructs an MQCFST instance populated from an MQMessage.
|
MQCFST(java.io.DataInput message,int encoding,int characterSet)
Constructs an MQCFST instance populated from a DataInput source.
|
MQCFST(int parameter,java.lang.String string)
Initializes an MQCFST with the specified values.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
equals(java.lang.Object obj)
Returns true when invoked with another MQCFST instance with the same parameter and equivalent
value.
|
|
getCodedCharSetId()
gets the coded character set identifier
|
|
getParameter()
gets the parameter identifier
|
|
getString()
gets the string
|
|
getStringLength()
gets the length of the string
|
|
getStringValue()
|
|
getStrucLength()
Get the length of the structure.
|
|
getType()
gets the structure type
|
|
getValue()
|
|
setCodedCharSetId(int value)
sets the coded character set identifier
|
|
setParameter(int value)
sets the parameter identifier
|
|
setString(java.lang.String value)
sets the string
|
|
write(java.io.DataOutput message,int parameter,java.lang.String string)
A convenience method for writing an MQCFST header structure with the specified values to an
MQMessage
|
Methods inherited from class com.ibm.mq.headers.pcf.PCFParameter |
---|
getHeaderVersion, getParameterName, hashCode, nextParameter |
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, size, store, store, toString, type, validate, write, write |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail
MQCFST
- public MQCFST()
Constructs an MQCFST instance with default field values.
MQCFST
- public MQCFST(java.io.DataInput message)
- throws MQDataException
- java.io.IOException
Constructs an MQCFST instance populated from an MQMessage.
Parameters:
message
- the message to read Throws:
MQDataException
- if the message content does not yield a valid MQCFST stucture java.io.IOException
- if there is a problem reading the message content MQCFST
- public MQCFST(java.io.DataInput message,
- int encoding,
- int characterSet)
- throws MQDataException
- java.io.IOException
Constructs an MQCFST 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:
MQDataException
- if the message content does not yield a valid MQCFST stucture java.io.IOException
- if there is a problem reading the message content MQCFST
- public MQCFST(int parameter,
- java.lang.String string)
Initializes an MQCFST with the specified values.
Parameters:
parameter
- the parameter identifier string
- the string parameter value Method Detail
write
- public static int write(java.io.DataOutput message,
- int parameter,
- java.lang.String string)
- throws java.io.IOException
A convenience method for writing an MQCFST header structure with the specified values to an
MQMessage
Parameters:
message
- the message to write to parameter
- the parameter identifier string
- the string parameter value Returns:
the number of bytes written
Throws:
java.io.IOException
- if there is a problem writing the message See Also:
equals
- public boolean equals(java.lang.Object obj)
Returns true when invoked with another MQCFST instance with the same parameter and equivalent
value. Comparison of the values is performed using the
equals
method of
String
.
Overrides:
equals
in class PCFParameter
Parameters:
obj
- Returns:
true if the object equals this one
getType
- public int getType()
gets the structure type
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)
sets the coded character set identifier
Parameters:
value
- the coded character set identifier getStringLength
- public int getStringLength()
gets the length of the string
Returns:
the length of the string
getString
- public java.lang.String getString( )
gets the string
Returns:
the string
setString
- public void setString(java.lang.String value)
sets the string
Parameters:
value
- the string getValue
- public java.lang.Object getValue( )
Description copied from class:
PCFParameter
gets the parameter value
Specified by:
getValue
in class PCFParameter
Returns:
the parameter value
getStringValue
- public java.lang.String getStringValue( )
Description copied from class:
PCFParameter
gets the parameter value as a String
Specified by:
getStringValue
in class PCFParameter
Returns:
the parameter value as a String