Package com.ibm.mq.headers.pcf

Class MQCFSL

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.MQCFSL
All Implemented Interfaces:
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 inherited from class com.ibm.mq.headers.internal.Header

    DEFAULT_CCSID, DEFAULT_ENCODING, delegate

    Fields inherited from class com.ibm.mq.jmqi.JmqiObject

    COMP_JM, COMP_JN, COMP_JO

  • Constructor Summary

    Constructors
    Constructor
    Description
    MQCFSL()
    Constructs an MQCFSL instance with default field values.
    MQCFSL(int parameter, String[] strings)
    Initializes an MQCFSL with the specified values.
    MQCFSL(DataInput message)
    Constructs an MQCFSL instance populated from an MQMessage.
    MQCFSL(DataInput message, int encoding, int characterSet)
    Constructs an MQCFSL instance populated from a DataInput source.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(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
    String[]
    getStrings()
    gets the string values
    String
    getStringValue()
    gets the parameter value as a String
    int
    getStrucLength()
    Get the length of the structure.
    int
    getType()
    gets the structure type
    Object
    getValue()
    gets the parameter value
    int
    hashCode()
    Returns a hash code value for the object
    void
    setCodedCharSetId(int value)
    sets the coded character set identifier
    void
    setParameter(int value)
    sets the parameter identifier
    void
    setStrings(String[] value)
    set the string values

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

    getHeaderVersion, getParameterName, 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 com.ibm.mq.jmqi.JmqiObject

    getJmqiEnvironment

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MQCFSL

      public MQCFSL()
      Constructs an MQCFSL instance with default field values.

    • MQCFSL

      public MQCFSL(DataInput message) throws MQDataException, IOException
      Constructs an MQCFSL instance populated from an MQMessage.
      Parameters:
      message - the message to read
      Throws:
      MQDataException - if the message content does not yield a valid MQCFSL stucture
      IOException - if there is a problem reading the message content

    • MQCFSL

      public MQCFSL(DataInput message, int encoding, int characterSet) throws MQDataException, 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:
      MQDataException - if the message content does not yield a valid MQCFSL stucture
      IOException - if there is a problem reading the message content

    • MQCFSL

      public MQCFSL(int parameter, String[] strings)
      Initializes an MQCFSL with the specified values.
      Parameters:
      parameter - the parameter identifier
      strings - the set of string values

  • Method Details

    • equals

      public boolean equals(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 - An object to compare with this instance
      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:

    • 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)
      sets 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
      Returns:
      the length of one string

    • getStrings

      public String[] getStrings()
      gets the string values
      Returns:
      an array of the string values

    • setStrings

      public void setStrings(String[] value)
      set the string values
      Parameters:
      value - an array of the string values

    • getValue

      public Object getValue()
      Description copied from class: PCFParameter
      gets the parameter value
      Specified by:
      getValue in class PCFParameter
      Returns:
      the parameter value
      See Also:

    • getStringValue

      public 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
      See Also: