|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Object
|
+--com.ibm.mq.pcf.PCFHeader
|
+--com.ibm.mq.pcf.PCFParameter
|
+--com.ibm.mq.pcf.MQCFST
A class encapsulating the MQCFST (PCF single string parameter) structure.
New in version 2.0:
| Field Summary | |
int |
codedCharSetId
|
static java.lang.String |
copyright
|
int |
parameter
|
java.lang.String |
string
|
int |
stringLength
|
int |
strucLength
|
static int |
type
|
| Constructor Summary | |
MQCFST()
Default constructor. |
|
MQCFST(int parameter,
java.lang.String string)
Initializes an MQCFST with the specified values. |
|
MQCFST(com.ibm.mq.MQMessage message)
Initializes a new MQCFST instance by reading from an MQMessage. |
|
| Method Summary | |
int |
getParameter()
Returns the parameter identifier of this PCF parameter structure. |
java.lang.String |
getStringValue()
Returns the PCF string parameter value. |
int |
getType()
Returns the type identifier of this PCF parameter structure. |
java.lang.Object |
getValue()
Returns the value of this PCF parameter structure. |
void |
initialize(com.ibm.mq.MQMessage message)
Initializes the contents of an MQCFST by reading from an MQMessage. |
void |
setString(java.lang.String string)
Sets the MQCFST string value in the string field, also updating the strucLength and stringLength fields. |
void |
setValue(java.lang.Object value)
Sets the value of this PCFParameter structure. |
int |
size()
Returns the size in bytes of this MQCFST (this will vary depending upon the string length). |
java.lang.String |
toString()
|
int |
write(com.ibm.mq.MQMessage message)
Writes the contents of an MQCFST to an MQMessage. |
static int |
write(com.ibm.mq.MQMessage message,
int parameter,
java.lang.String string)
A convenience method for writing an MQCFIN header structure with the specified values to an MQMessage |
| Methods inherited from class com.ibm.mq.pcf.PCFParameter |
nextParameter |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final java.lang.String copyright
public static final int type
public int strucLength
public int parameter
public int codedCharSetId
public int stringLength
public java.lang.String string
| Constructor Detail |
public MQCFST()
public MQCFST(int parameter,
java.lang.String string)
parameter - the parameter identifiervalue - the string parameter valueCMQCFC
public MQCFST(com.ibm.mq.MQMessage message)
throws com.ibm.mq.MQException,
java.io.IOException
message - the message to read fromcom.ibm.mq.MQException - if the message contents do not yield a valid
MQCFST structurejava.io.IOException - if there is a problem reading the message| Method Detail |
public static int write(com.ibm.mq.MQMessage message,
int parameter,
java.lang.String string)
throws java.io.IOException
message - the message to write toparameter - the parameter identifierstring - the string parameter valuejava.io.IOException - if there is a problem writing the messageCMQCFC
public void initialize(com.ibm.mq.MQMessage message)
throws com.ibm.mq.MQException,
java.io.IOException
initialize in class PCFHeadermessage - the message to read fromcom.ibm.mq.MQException - if the message contents do not yield a valid
MQCFST structure:
java.io.IOException - if there is a problem reading the message
public int write(com.ibm.mq.MQMessage message)
throws java.io.IOException
write in class PCFHeadermessage - the message to write tojava.io.IOException - if there is a problem writing the messagepublic int size()
size in class PCFHeaderpublic int getType()
getType in class PCFParameterpublic int getParameter()
getParameter in class PCFParameterpublic java.lang.Object getValue()
getValue in class PCFParameterpublic java.lang.String getStringValue()
getStringValue in class PCFParameter
public void setValue(java.lang.Object value)
throws java.lang.ClassCastException
setValue in class PCFParametervalue - the string list valuepublic void setString(java.lang.String string)
string - the string valuepublic java.lang.String toString()
toString in class java.lang.Object
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||