|
||||||||
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.MQCFSL
A class encapsulating the MQCFSL (PCF string list parameter) structure.
New in version 2.0:
Field Summary | |
int |
codedCharSetId
|
static java.lang.String |
copyright
|
int |
count
|
int |
parameter
|
int |
stringLength
|
java.lang.String[] |
strings
|
int |
strucLength
|
static int |
type
|
Constructor Summary | |
MQCFSL()
Default constructor. |
|
MQCFSL(int parameter,
java.lang.String[] strings)
Initializes an MQCFSL with the specified values. |
|
MQCFSL(com.ibm.mq.MQMessage message)
Initializes a new MQCFSL instance by reading from an MQMessage. |
Method Summary | |
int |
getParameter()
Returns the parameter identifier of this PCF parameter structure. |
java.lang.String |
getStringValue()
Returns a single string representing the values of this PCF string array structure, one value per line. |
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 MQCFSL by reading from an MQMessage. |
void |
setStrings(java.lang.String[] strings)
Sets the MQCFSL string values in the strings field, also updating the strucLength, stringLength, and count fields. |
void |
setValue(java.lang.Object value)
Sets the value of this PCFParameter structure. |
int |
size()
Returns the size in bytes of this MQCFSL (this will vary depending upon the string length and the size of the string array). |
java.lang.String |
toString()
|
int |
write(com.ibm.mq.MQMessage message)
Writes the contents of a MQCFH to an MQMessage. |
static int |
write(com.ibm.mq.MQMessage message,
int parameter,
java.lang.String[] strings)
A convenience method for writing an MQCFSL header structure with the specified values to a message. |
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 count
public int stringLength
public java.lang.String[] strings
Constructor Detail |
public MQCFSL()
public MQCFSL(int parameter, java.lang.String[] strings)
parameter
- the parameter identifierstrings
- the set of string valuespublic MQCFSL(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
MQCFSL structurejava.io.IOException
- if there is a problem reading the messageMethod Detail |
public static int write(com.ibm.mq.MQMessage message, int parameter, java.lang.String[] strings) throws java.io.IOException
message
- the message to write toparameter
- the parameter identifierstrings
- the set of string valuesCMQCFC
public void initialize(com.ibm.mq.MQMessage message) throws com.ibm.mq.MQException, java.io.IOException
initialize
in class PCFHeader
message
- the message to read fromcom.ibm.mq.MQException
- if the message contents do not yield a valid
MQCFSL structure:
java.io.IOException
- if there is a problem reading the messagepublic int write(com.ibm.mq.MQMessage message) throws java.io.IOException
write
in class PCFHeader
message
- the message to write tojava.io.IOException
- if there is a problem writing the messagepublic int size()
size
in class PCFHeader
public int getType()
getType
in class PCFParameter
public int getParameter()
getParameter
in class PCFParameter
public java.lang.Object getValue()
getValue
in class PCFParameter
public java.lang.String getStringValue()
getStringValue
in class PCFParameter
public void setValue(java.lang.Object value) throws java.lang.ClassCastException
setValue
in class PCFParameter
value
- the string list valuepublic void setStrings(java.lang.String[] strings)
strings
- the string value arraypublic 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 |