com.ibm.mq.headers.pcf
类 MQEPH
- java.lang.Object
- com.ibm.mq.jmqi.JmqiObject
- com.ibm.mq.headers.internal.Header
- com.ibm.mq.headers.pcf.MQEPH
- 所有已实现的接口:
- MQChainable, MQData, MQHeader和 PCFContent
公用类 MQEPH 扩展 com.ibm.mq.headers.internal.Header 实现 MQChainable, PCFContent
MQEPH (嵌入式 PCF) 头类。struct tagMQEPH { MQCHAR4 StrucId; // 结构标识 MQLONG 版本; // 结构版本号 MQLONG StrucLength; // MQEPH 的总长度,包括后续的 MQCFHameter 结构 MQLONG 编码; // 遵循最后一个 PCF 参数结构的数据的数字编码 MQLONG CodedCharSetId; // 遵循最后一个 PCF 参数结构的数据的字符集标识 MQCHAR8 格式; // 最后一个 PCF 参数结构后面的数据的格式名 MQLONG 标志; // 标志 MQCFH PCFHeader; // 可编程命令格式头 }
-
嵌套类摘要
-
从接口 com.ibm.mq.headers继承的嵌套类/接口。MQHeader
MQHeader.Field
-
-
字段摘要
字段 修饰符和类型 字段和描述 static intSIZEMQEPH 头的大小 (以字节计)
-
构造函数摘要
构造函数 构造函数和描述 MQEPH()使用缺省字段值构造 MQEPH 实例。MQEPH(java.io.DataInput message)构造从 DataInput填充的 MQEPH 实例。MQEPH(java.io.DataInput message, int encoding, int characterSet)构造从 DataInput 源填充的 MQEPH 实例。
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法和描述 voidaddFilterParameter(int parameter, int operator, byte[] value)向组添加字节字符串过滤器参数。voidaddFilterParameter(int parameter, int operator, int value)向组添加整数过滤器参数。voidaddFilterParameter(int parameter, int operator, java.lang.String value)向组添加字符串过滤器参数。voidaddParameter(int parameter, byte[] value)将字节数组参数添加到组。voidaddParameter(int parameter, int value)向组添加整数参数。voidaddParameter(int parameter, int[] values)将整数列表参数添加到组。voidaddParameter(int parameter, long value)将 64 位整数参数添加到组。voidaddParameter(int parameter, long[] values)将 64 位整数列表参数添加到组。voidaddParameter(int parameter, java.lang.String value)向组添加字符串参数。voidaddParameter(int parameter, java.lang.String[] values)向组添加字符串列表参数。voidaddParameter(PCFParameter parameter)将 PCFParameter 添加到组。booleanequals(java.lang.Object obj)如果使用另一个具有相同参数 parameterCount和参数子代的 MQCFGR 实例进行调用,那么返回 true。java.lang.Stringformat()byte[]getBytesParameterValue(int parameter)返回指定字节数组参数 (MQCFBS) 的值。intgetCodedCharSetId()获取后续数据的字符集标识。intgetEncoding()获取后续数据的数字编码。intgetFlags()获取标志java.lang.StringgetFormat()获取遵循最后一个 PCF 参数结构的数据的格式名longgetInt64ParameterValue(int parameter)以整数形式返回指定整数参数 (MQCFIN64) 的值。long[]getIntList64ParameterValue(int parameter)以整数数组形式返回指定整数列表参数 (MQCFIL64) 的值。int[]getIntListParameterValue(int parameter)以整数数组的形式返回指定整数列表参数 (MQCFIL) 的值。intgetIntParameterValue(int parameter)以整数形式返回指定整数参数 (MQCFIN) 的值。PCFParametergetParameter(int parameter)返回指定参数的 PCFParameter 结构,如果找不到该参数,那么返回 null。intgetParameterCount()返回组中的参数结构数。java.util.EnumerationgetParameters()返回组中参数的枚举。java.lang.ObjectgetParameterValue(int parameter)返回指定参数的值,如果找不到参数,那么返回 null。MQCFHgetPCFHeader()获取 PCF 头java.lang.String[]getStringListParameterValue(int parameter)以字符串数组形式返回指定字符串列表参数 (MQCFSL) 的值。java.lang.StringgetStringParameterValue(int parameter)以字符串形式返回指定字符串参数 (MQCFST) 的值。java.lang.StringgetStrucId()获取结构标识; 值将为 MQEPH_STRUC_IDintgetVersion()获取结构版本号intnextCharacterSet()获取下一条消息的 CCSIDvoidnextCharacterSet(int value)设置下一条消息的 CCSIDintnextEncoding()获取下一条消息的编码voidnextEncoding(int value)设置下一条消息的编码java.lang.StringnextFormat()获取下一条消息的格式voidnextFormat(java.lang.String value)设置下一条消息的格式intread(java.io.DataInput message, int encoding, int characterSet)使用指定消息中的数据填充此 MQEPH 对象voidsetCodedCharSetId(int value)设置后续数据的字符集标识。voidsetEncoding(int value)设置后续数据的数字编码。voidsetFlags(int value)设置标志voidsetFormat(java.lang.String value)设置遵循最后一个 PCF 参数结构的数据的格式名voidsetParameterCount(int value)设置 MQEPH 参数计数。voidsetPCFHeader(MQCFH value)设置 PCF 头java.lang.StringtoString()返回此头的字符串表示intwrite(java.io.DataOutput message, int encoding, int characterSet)将此头写入指定的消息-
从类 com.ibm.mq.headers.internal.Header 继承的方法
characterSet, encoding, fields, getBytesValue, getCharValue, getCharValue, getIntValue, getJmqiEnv, getStringValue, getValue, headerType, read, read, setBytesValue, setCharValue, setCharValue, setIntValue, setStringValue, setValue, size, store, store, type, validate, write
-
-
-
字段详细信息
大小
公共静态最终整数大小
MQEPH 头的大小 (以字节计)- 另请参阅:
- 常量字段值
-
构造函数详细信息
MQEPH
公共 MQEPH ()
使用缺省字段值构造 MQEPH 实例。
MQEPH
public MQEPH (java.io.DataInput 消息) 抛出 MQDataException, java.io.IOException构造从 DataInput填充的 MQEPH 实例。- 参数:
message-要读取的消息- 抛出:
MQDataException-如果消息内容未生成有效的 MQEPH stucturejava.io.IOException-如果读取消息内容时发生问题
MQEPH
public MQEPH (java.io.DataInput 消息, int encoding, int characterSet) 抛出 MQDataException, java.io.IOException构造从 DataInput 源填充的 MQEPH 实例。- 参数:
message-要读取的 DataInput 或其他 DataInput 源encoding-消息中数据的初始数字编码characterSet-消息中数据的初始 CCSID- 抛出:
MQDataException-如果消息内容未生成有效的 MQEPH stucturejava.io.IOException-如果读取消息内容时发生问题
-
方法详细信息
读
public int read (java.io.DataInput 消息, int encoding, int characterSet) 抛出 MQDataException, java.io.IOException使用指定消息中的数据填充此 MQEPH 对象- 指定者:
read在接口中MQData- 覆盖:
read的实例com.ibm.mq.headers.internal.Header- 参数:
message-消息encoding-编码 (big/little-endian)characterSet-CCSID- 返回:
- 读取的字节数
- 抛出:
MQDataExceptionjava.io.IOException
写
public int write (java.io.DataOutput 消息, int encoding, int characterSet) 抛出 java.io.IOException将此头写入指定的消息
getStruc标识
public java.lang.String getStrucId ()
获取结构标识; 值将为 MQEPH_STRUC_ID- 返回:
- 结构标识
getVersion
public int getVersion()
获取结构版本号- 返回:
- 结构版本号
getEncoding
public int getEncoding()
获取后续数据的数字编码。- 返回:
- 数字编码。 MQENC_ * 值的组合。
setEncoding
public void setEncoding(整数值)
设置后续数据的数字编码。- 参数:
value-数字编码。 MQENC_ * 值的组合。
getCodedCharSet标识
public int getCodedCharSetId ()
获取后续数据的字符集标识。- 返回:
- 字符集标识。
setCodedCharSet标识
public void setCodedCharSetId (int value)
设置后续数据的字符集标识。- 参数:
value-字符集标识。
getFormat
public java.lang.String getFormat()
获取遵循最后一个 PCF 参数结构的数据的格式名- 返回:
- 最后一个 PCF 参数结构后面的数据的格式名
setFormat
public void setFormat(java.lang.String 值)
设置遵循最后一个 PCF 参数结构的数据的格式名- 参数:
value-遵循最后一个 PCF 参数结构的数据的格式名
getFlags
public int getFlags()
获取标志- 返回:
- 标志
setFlags
public void setFlags(整数值)
设置标志- 参数:
value-标志
getPCFHeader
public MQCFH getPCFHeader()
获取 PCF 头- 返回:
- 头
setPCFHeader
public void setPCFHeader(MQCFH 值)
设置 PCF 头- 参数:
value-头
nextEncoding
public int nextEncoding()
获取下一条消息的编码- 指定者:
nextEncoding在接口中MQChainable- 返回:
- 编码
nextEncoding
public void nextEncoding(整数值)
设置下一条消息的编码- 指定者:
nextEncoding在接口中MQChainable- 参数:
value-编码
nextCharacter集
public int nextCharacterSet ()
获取下一条消息的 CCSID- 指定者:
nextCharacterSet在接口中MQChainable- 返回:
- CCSID
nextCharacter集
public void nextCharacterSet (int value)
设置下一条消息的 CCSID- 指定者:
nextCharacterSet在接口中MQChainable- 参数:
value-CCSID
nextFormat
public java.lang.String nextFormat()
获取下一条消息的格式- 指定者:
nextFormat在接口中MQChainable- 返回:
- 格式
nextFormat
public void nextFormat(java.lang.String 值)
设置下一条消息的格式- 指定者:
nextFormat在接口中MQChainable- 参数:
value-格式
格式
public java.lang.String format ()
- 指定者:
format在接口中MQChainable- 返回:
- 与此头对象或消息内容关联的格式。
- 另请参阅:
MQChainable.format()
addParameter
public void addParameter(PCFParameter 参数)
从接口复制的描述:PCFContent将 PCFParameter 添加到组。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-要添加的参数结构 (MQCFIN , MQCFIL , MQCFST 等)- 另请参阅:
PCFContent.addParameter(com.ibm.mq.headers.pcf.PCFParameter)
addParameter
public void addParameter(int 参数, int 值)从接口复制的描述:PCFContent向组添加整数参数。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-整数参数标识value-整数值- 另请参阅:
PCFContent.addParameter(int, int)
addParameter
public void addParameter(int 参数, int [] 值)从接口复制的描述:PCFContent将整数列表参数添加到组。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-整数列表参数标识values-整数值的数组- 另请参阅:
PCFContent.addParameter(int, int[])
addParameter
public void addParameter(int 参数, long 值)从接口复制的描述:PCFContent将 64 位整数参数添加到组。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-整数参数标识value-整数值- 另请参阅:
PCFContent.addParameter(int, long)
addParameter
public void addParameter(int 参数, long [] 值)从接口复制的描述:PCFContent将 64 位整数列表参数添加到组。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-整数列表参数标识values-整数值的数组- 另请参阅:
PCFContent.addParameter(int, long[])
addParameter
public void addParameter(int 参数, java.lang.String 值)从接口复制的描述:PCFContent向组添加字符串参数。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-字符串参数标识value-字符串值- 另请参阅:
PCFContent.addParameter(int, java.lang.String)
addParameter
public void addParameter(int 参数, java.lang.String[] 值)从接口复制的描述:PCFContent向组添加字符串列表参数。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-字符串列表参数标识values-字符串值的数组- 另请参阅:
PCFContent.addParameter(int, java.lang.String[])
addParameter
public void addParameter(int 参数, byte [] 值)从接口复制的描述:PCFContent将字节数组参数添加到组。- 指定者:
addParameter在接口中PCFContent- 参数:
parameter-字符串列表参数标识value-字符串值的数组- 另请参阅:
PCFContent.addParameter(int, byte[])
addFilter参数
public void addFilter参数 (int 参数, int 运算符, int 值)从接口复制的描述:PCFContent向组添加整数过滤器参数。- 指定者:
addFilterParameter在接口中PCFContent- 参数:
parameter-过滤器参数标识operator-其中一个 MQCFOP_ * 过滤器运算符常量value-过滤器值- 另请参阅:
PCFContent.addFilterParameter(int, int, int)
addFilter参数
public void addFilter参数 (int 参数, int 运算符, java.lang.String 值)从接口复制的描述:PCFContent向组添加字符串过滤器参数。- 指定者:
addFilterParameter在接口中PCFContent- 参数:
parameter-过滤器参数标识operator-其中一个 MQCFOP_ * 过滤器运算符常量value-过滤器值- 另请参阅:
PCFContent.addFilterParameter(int, int, java.lang.String)
addFilter参数
public void addFilter参数 (int 参数, int 运算符, byte [] 值)从接口复制的描述:PCFContent向组添加字节字符串过滤器参数。- 指定者:
addFilterParameter在接口中PCFContent- 参数:
parameter-过滤器参数标识operator-其中一个 MQCFOP_ * 过滤器运算符常量value-过滤器值- 另请参阅:
PCFContent.addFilterParameter(int, int, byte[])
getParameterCount
public int getParameter计数 ()
从接口复制的描述:PCFContent返回组中的参数结构数。- 指定者:
getParameterCount在接口中PCFContent- 返回:
- MQCFH 中 parameterCount 字段的值
- 另请参阅:
PCFContent.getParameterCount()
setParameter计数
public void setParameter计数 (int 值)
设置 MQEPH 参数计数。 这会将子 PCFParameter 集合的大小修剪为指定的数字。 如果自变量为零,那么效果是清除所有子参数。 指定大于当前参数计数的值没有任何作用。 将忽略负值。- 参数:
value-整数值作为整数对象
getParameters
public java.util.Enumeration getParameters()
从接口复制的描述:PCFContent返回组中参数的枚举。 返回的枚举元素是个别 PCFParameter 实例 (MQCFIN , MQCFIL , MQCFST 或 MQCFSL 等实例)。- 指定者:
getParameters在接口中PCFContent- 返回:
- PCF 消息参数结构
- 另请参阅:
PCFContent.getParameters()
getParameter
public PCFParameter getParameter(int 参数)
从接口复制的描述:PCFContent返回指定参数的 PCFParameter 结构,如果找不到该参数,那么返回 null。- 指定者:
getParameter在接口中PCFContent- 返回:
- 指定的参数对象
- 另请参阅:
PCFContent.getParameter(int)
getParameter值
public java.lang.Object getParameter值 (int 参数)
从接口复制的描述:PCFContent返回指定参数的值,如果找不到参数,那么返回 null。 返回的对象是单个整数,单个字符串,整数数组或字符串数组,具体取决于 PCFParameter 的类型。 调用者可以从提供的参数标识推断期望的返回类型。- 指定者:
getParameterValue在接口中PCFContent- 返回:
- 指定的参数值
- 另请参阅:
PCFContent.getParameterValue(int)
getIntParameterValue
public int getIntParameterValue(int 参数) 抛出 PCFException从接口复制的描述:PCFContent以整数形式返回指定整数参数 (MQCFIN) 的值。- 指定者:
getIntParameterValue在接口中PCFContent- 参数:
parameter-整数参数标识- 返回:
- 整数参数值
- 抛出:
PCFException-如果消息中不存在指定的参数 (给出的原因码为 MQRCCF_CFIN_PARM_ID_ERROR)- 另请参阅:
PCFContent.getIntParameterValue(int)
getIntListParameter值
public int [] getIntListParameter值 (int 参数) 抛出 PCFException从接口复制的描述:PCFContent以整数数组的形式返回指定整数列表参数 (MQCFIL) 的值。- 指定者:
getIntListParameterValue在接口中PCFContent- 参数:
parameter-整数列表参数标识- 返回:
- 整数列表参数值
- 抛出:
PCFException-如果指定的参数在组中不存在 (给出的原因码为 MQRCCF_CFIL_PARM_ID_ERROR)- 另请参阅:
PCFContent.getIntListParameterValue(int)
getInt64ParameterValue
public long getInt64ParameterValue(int 参数) 抛出 PCFException从接口复制的描述:PCFContent以整数形式返回指定整数参数 (MQCFIN64) 的值。- 指定者:
getInt64ParameterValue在接口中PCFContent- 参数:
parameter-整数参数标识- 返回:
- 整数参数值
- 抛出:
PCFException-如果消息中不存在指定的参数 (给出的原因码为 MQRCCF_CFIN_PARM_ID_ERROR)- 另请参阅:
PCFContent.getInt64ParameterValue(int)
getIntList64ParameterValue
public long [] getIntList64ParameterValue(int 参数) 抛出 PCFException从接口复制的描述:PCFContent以整数数组形式返回指定整数列表参数 (MQCFIL64) 的值。- 指定者:
getIntList64ParameterValue在接口中PCFContent- 参数:
parameter-整数列表参数标识- 返回:
- 整数列表参数值
- 抛出:
PCFException-如果指定的参数在组中不存在 (给出的原因码为 MQRCCF_CFIL_PARM_ID_ERROR)- 另请参阅:
PCFContent.getIntList64ParameterValue(int)
getStringParameterValue
public java.lang.String getStringParameterValue(int 参数) 抛出 PCFException从接口复制的描述:PCFContent以字符串形式返回指定字符串参数 (MQCFST) 的值。- 指定者:
getStringParameterValue在接口中PCFContent- 参数:
parameter-字符串参数标识- 返回:
- 字符串参数值
- 抛出:
PCFException-如果指定的参数在组中不存在 (给出的原因码为 MQRCCF_CFST_PARM_ID_ERROR)- 另请参阅:
PCFContent.getStringParameterValue(int)
getStringListParameter值
public java.lang.String[] getStringListParameter值 (int 参数) 抛出 PCFException从接口复制的描述:PCFContent以字符串数组形式返回指定字符串列表参数 (MQCFSL) 的值。- 指定者:
getStringListParameterValue在接口中PCFContent- 参数:
parameter-字符串列表参数标识- 返回:
- 字符串列表参数值
- 抛出:
PCFException-如果组中不存在指定的参数 (给出的原因码为 MQRCCF_CFSL_PARM_ID_ERROR; 未定义更具体的错误代码)- 另请参阅:
PCFContent.getStringListParameterValue(int)
getBytesParameterValue
public byte [] getBytesParameterValue(int 参数) 抛出 PCFException从接口复制的描述:PCFContent返回指定字节数组参数 (MQCFBS) 的值。- 指定者:
getBytesParameterValue在接口中PCFContent- 参数:
parameter-字节数组参数标识- 返回:
- 字节数组参数值
- 抛出:
PCFException-如果指定的参数在组中不存在 (给出的原因码为 MQRCCF_CFBS_PARM_ID_ERROR)- 另请参阅:
PCFContent.getBytesParameterValue(int)
等于
public boolean 等于 (java.lang.Object obj)
如果使用另一个具有相同参数 parameterCount和参数子代的 MQCFGR 实例进行调用,那么返回 true。- 覆盖:
equals的实例java.lang.Object
toString
public java.lang.String toString()
返回此头的字符串表示- 覆盖:
toString的实例com.ibm.mq.headers.internal.Header
-