gu.dtalk

类 CmdItem

java.lang.Object

gu.dtalk.BaseItem

gu.dtalk.CmdItem

public class CmdItem
extends BaseItem

设备命令条目

作者:

guyadong

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	CmdItem.ICmdAdapter 设备命令执行接口

字段概要

从类继承的字段 gu.dtalk.BaseItem

items

构造器概要

构造器

构造器和说明
CmdItem()

方法概要

方法

限定符和类型	方法和说明
CmdItem	addParameters(BaseOption<?>... parameter)
CmdItem	addParameters(java.util.Collection<BaseOption<?>> parameters)
CmdItem	asTaskAdapter(java.lang.String queue) 将当前命令作为任务对象注册到指定的任务队列，可以执行队列中的任务 cmdAdapter为null时无效
CmdItem	asTaskAdapter(java.lang.String queue, java.lang.Class<? extends TaskAdapter> taskAdatperClass) 将当前命令作为任务对象注册到指定的任务队列，可以执行队列中的任务 cmdAdapter为null时无效
static <T> T	cast(java.lang.Object value, java.lang.reflect.Type type) 将value转为type指定的类型
ItemType	getCatalog()
CmdItem.ICmdAdapter	getCmdAdapter()
<T> BaseOption<T>	getParameter(java.lang.String name)
java.util.List<BaseOption<java.lang.Object>>	getParameters()
java.lang.String	getTaskQueue()
boolean	isContainer()
CmdItem	reset() 设置所有参数为null
java.lang.Object	runCmd() 执行命令
CmdItem	setCmdAdapter(CmdItem.ICmdAdapter cmdAdapter)
void	setParameters(java.util.List<BaseOption<?>> parameters)
void	setTaskQueue(java.lang.String taskQueue)

从类继承的方法 gu.dtalk.BaseItem

addChilds, addChilds, childCount, childNames, equals, find, findBase64Option, findBoolOption, findChecked, findCheckOption, findCmd, findCmdChecked, findDateOption, findFloatOption, findImageOption, findIntOption, findIPv4Option, findMACOption, findMenu, findMenuChecked, findOption, findOptionChecked, findPasswordOption, findStringOption, findSwitchOption, findUrlOption, getChild, getChildByPath, getChilds, getDescription, getName, getParent, getPath, getUiName, hashCode, isDisable, isEmpty, json, setChilds, setDescription, setDisable, setName, setPath, setUiName, toString, updateChild

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

CmdItem

public CmdItem()

方法详细资料

isContainer

public final boolean isContainer()

指定者:

isContainer 在类中 BaseItem

返回:

是否为容器(可包含item)

getCatalog

public final ItemType getCatalog()

指定者:

getCatalog 在类中 BaseItem

返回:

返回item分类类型

getParameters

public java.util.List<BaseOption<java.lang.Object>> getParameters()

setParameters

public void setParameters(java.util.List<BaseOption<?>> parameters)

addParameters

public CmdItem addParameters(BaseOption<?>... parameter)

addParameters

public CmdItem addParameters(java.util.Collection<BaseOption<?>> parameters)

getCmdAdapter

public CmdItem.ICmdAdapter getCmdAdapter()

setCmdAdapter

public CmdItem setCmdAdapter(CmdItem.ICmdAdapter cmdAdapter)

cast

public static final <T> T cast(java.lang.Object value,
         java.lang.reflect.Type type)

将value转为type指定的类型

类型参数:

T - 目标参数类型

参数:

value -

type -

返回:

另请参阅:

TypeUtils.cast(Object, Type, ParserConfig)

runCmd

public final java.lang.Object runCmd()
                              throws CmdExecutionException

执行命令

返回:

抛出:

CmdExecutionException - 设备命令执行异常

getParameter

public <T> BaseOption<T> getParameter(java.lang.String name)

reset

public CmdItem reset()

设置所有参数为null

返回:

返回当前对象

asTaskAdapter

public CmdItem asTaskAdapter(java.lang.String queue)

将当前命令作为任务对象注册到指定的任务队列，可以执行队列中的任务
cmdAdapter为null时无效

参数:

queue -

返回:

返回当前对象

asTaskAdapter

public CmdItem asTaskAdapter(java.lang.String queue,
                    java.lang.Class<? extends TaskAdapter> taskAdatperClass)

将当前命令作为任务对象注册到指定的任务队列，可以执行队列中的任务
cmdAdapter为null时无效

参数:

taskAdatperClass - 任务对象类,必须有(String)构造方法,应用层可以继承TaskAdapter 重写TaskAdapter#makeAck(Object, Exception, String, Long)方法,返回不同的响应对象

返回:

返回当前对象

getTaskQueue

public java.lang.String getTaskQueue()

返回:

taskQueue

setTaskQueue

public void setTaskQueue(java.lang.String taskQueue)

参数:

taskQueue - 要设置的 taskQueue