gu.dtalk

类 BaseOption<T>

java.lang.Object

gu.dtalk.BaseItem

gu.dtalk.BaseOption<T>

类型参数:

T - 实例封装的数据类型

直接已知子类:

BaseBinary, BaseNumOption, BoolOption, CheckOption, DateOption, StringOption, UrlOption

public abstract class BaseOption<T>
extends BaseItem

用于参数配置和命令参数的选项对象

作者:

guyadong

字段概要

字段

限定符和类型	字段和说明
protected java.util.Observable	observable 侦听器管理对象
protected java.lang.reflect.Type	type 当前选项的java类型

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

items

构造器概要

构造器

构造器和说明
BaseOption(java.lang.reflect.Type type)

方法概要

方法

限定符和类型	方法和说明
BaseItem	addChilds(java.util.Collection<BaseItem> childs) 添加子条目
BaseOption<T>	addListener(ValueListener<T>... listeners) 添加事件侦听器
BaseOption<T>	asDefaultValue(java.lang.String input) 以字符串形式设置默认值
BaseOption<T>	asValue(java.lang.String input) 以字符串形式设置值
BaseOption<T>	compile() 检查value,defaultValue的有效性，无效则抛出异常
java.lang.String	contentOfValue()
BaseOption<T>	deleteListener(ValueListener<T>... listeners)
T	fetch() 返回选项的值，如果为null则返回默认值
ItemType	getCatalog()
T	getDefaultValue()
abstract OptionType	getType()
T	getValue()
boolean	isContainer()
boolean	isReadOnly()
boolean	isRequired()
java.lang.reflect.Type	javaType()
BaseOption<T>	setDefaultValue(T defaultValue) 设置默认值，同时验证数据有效性，失败抛出异常
BaseOption<T>	setReadOnly(boolean readOnly) 设置该选项是否为只读的
BaseOption<T>	setRequired(boolean required) 设置该选项是否为必须的
BaseOption<T>	setValidator(com.google.common.base.Predicate<T> validator) 设置数据验证器
BaseOption<T>	setValue(T value) 设置指定的值 如果值有改变则向observer发送ValueChangeEvent消息
void	updateFrom(BaseOption<T> req) 用选项req的值更新当前选项的值
void	updateFrom(T value) 更新选项的值，如果选项为只读(readonly)或value不满足条件(validate(Object))则抛出异常
boolean	validate(java.lang.Object value) 验证value是否有效,该方法不会抛出异常

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

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

字段详细资料

type

protected final java.lang.reflect.Type type

当前选项的java类型

observable

protected final java.util.Observable observable

侦听器管理对象

构造器详细资料

BaseOption

public BaseOption(java.lang.reflect.Type type)

方法详细资料

javaType

public java.lang.reflect.Type javaType()

返回:

当前选项的java类型

getType

public abstract OptionType getType()

返回:

当前选项的类型

isReadOnly

public boolean isReadOnly()

返回:

该选项是否为只读的

setReadOnly

public BaseOption<T> setReadOnly(boolean readOnly)

设置该选项是否为只读的

参数:

readOnly -

返回:

当前对象

isContainer

public final boolean isContainer()

指定者:

isContainer 在类中 BaseItem

返回:

是否为容器(可包含item)

getCatalog

public final ItemType getCatalog()

指定者:

getCatalog 在类中 BaseItem

返回:

返回item分类类型

addChilds

public final BaseItem addChilds(java.util.Collection<BaseItem> childs)

从类复制的说明: BaseItem

添加子条目

覆盖:

addChilds 在类中 BaseItem

返回:

当前对象

validate

public boolean validate(java.lang.Object value)

验证value是否有效,该方法不会抛出异常

参数:

value -

返回:

成功返回true，否则返回false

getValue

public final T getValue()

返回:

选项值

setValue

public BaseOption<T> setValue(T value)

设置指定的值
如果值有改变则向observer发送ValueChangeEvent消息

参数:

value -

返回:

当前对象

抛出:

java.lang.IllegalArgumentException - 数值验证失败

另请参阅:

validate(Object)

updateFrom

public void updateFrom(T value)

更新选项的值，如果选项为只读(readonly)或value不满足条件(validate(Object))则抛出异常

参数:

value -

另请参阅:

setValue(Object)

updateFrom

public void updateFrom(BaseOption<T> req)

用选项req的值更新当前选项的值

参数:

req -

另请参阅:

updateFrom(Object)

getDefaultValue

public final T getDefaultValue()

返回:

返回缺省值

setDefaultValue

public BaseOption<T> setDefaultValue(T defaultValue)

设置默认值，同时验证数据有效性，失败抛出异常

参数:

defaultValue -

返回:

抛出:

java.lang.IllegalArgumentException - 数值验证失败

另请参阅:

validate(Object)

fetch

public T fetch()

返回选项的值，如果为null则返回默认值

返回:

setValidator

public BaseOption<T> setValidator(com.google.common.base.Predicate<T> validator)

设置数据验证器

参数:

validator - 为null忽略

返回:

isRequired

public boolean isRequired()

返回:

该选项是否为必须的

setRequired

public BaseOption<T> setRequired(boolean required)

设置该选项是否为必须的

参数:

required -

返回:

当前对象

contentOfValue

public java.lang.String contentOfValue()

返回:

将选项的值转为用于显示的字符串

asValue

public BaseOption<T> asValue(java.lang.String input)

以字符串形式设置值

参数:

input - 如果不符合数据类型的格式则抛出异常

返回:

另请参阅:

OptionType.trans()

asDefaultValue

public BaseOption<T> asDefaultValue(java.lang.String input)

以字符串形式设置默认值

参数:

input - 如果不符合数据类型的格式则抛出异常

返回:

另请参阅:

OptionType.trans()

compile

public BaseOption<T> compile()

检查value,defaultValue的有效性，无效则抛出异常

抛出:

java.lang.IllegalArgumentException - value,defaultValue的值无效

addListener

@SafeVarargs
public final BaseOption<T> addListener(ValueListener<T>... listeners)

添加事件侦听器

参数:

listeners -

返回:

deleteListener

@SafeVarargs
public final BaseOption<T> deleteListener(ValueListener<T>... listeners)