Module (btg-set 4.1.5 API)

java.lang.Object
- cn.zcltd.btg.set.core.Module

所有已实现的接口:

ParamGetter, ToJson, ToXml
```
public class Module
extends Object
implements ToJson, ToXml, ParamGetter
```
模块，包含模块所有参数信息

构造器概要

构造器
构造器和说明

Module(String id, String name, Config config)

构造器
构造器和说明
`Module(String id, String name, Config config)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addParam(Param param)` 添加一个参数
`Param`	`createParam(String paramId, String paramName, ParamType paramType, String paramValue)` 为当前module创建一个param
`void`	`deleteParam(String paramId)` 删除一个参数
`boolean`	`equals(Module target)`
`BigDecimal`	`getBigDecimal(String key)` 根据key获取BigDecimal类型的值
`BigDecimal`	`getBigDecimal(String key, BigDecimal defaultValue)` 根据key获取BigDecimal类型的值，若为null返回默认值
`Boolean`	`getBoolean(String key)` 根据key获取Boolean类型的值
`Boolean`	`getBoolean(String key, Boolean defaultValue)` 根据key获取Boolean类型的值，若为null返回默认值
`Config`	`getConfig()`
`Date`	`getDate(String key)` 根据key获取Date类型的值根据参数类型、值类型、长度自动匹配对应的格式：若为Boolean类型，放弃转换，返回null 若为Number类型将去掉小数后的值作为Date.getTime值转换为date；若为String类型：当Param对象指定了datePattern则直接使用，否则若length为10，对应“yyyy-MM-dd” 若length为8，对应“HH:mm:ss” 若length为19，对应“yyyy-MM-dd HH:mm:ss” 若length为17，对应“yyyyMMddHHmmssSSS” 若为其他，无法识别，返回null
`Date`	`getDate(String key, Date defaultValue)` 根据key获取Date类型的值，若为null返回默认值根据参数类型、值类型、长度自动匹配对应的格式：若为Boolean类型，放弃转换，返回defaultValue 若为Number类型将去掉小数后的值作为Date.getTime值转换为date；若为String类型：当Param对象指定了datePattern则直接使用，否则若length为10，对应“yyyy-MM-dd” 若length为8，对应“HH:mm:ss” 若length为19，对应“yyyy-MM-dd HH:mm:ss” 若length为17，对应“yyyyMMddHHmmssSSS” 若为其他，无法识别，返回defaultValue
`Date`	`getDate(String key, String datePattern)` 根据key和指定格式化参数获取Date类型的值
`Date`	`getDate(String key, String datePattern, Date defaultValue)` 根据key和指定格式化参数获取Date类型的值，若为null返回默认值
`String`	`getDesc()`
`Double`	`getDouble(String key)` 根据key获取Double类型的值
`Double`	`getDouble(String key, Double defaultValue)` 根据key获取Double类型的值，若为null返回默认值
`Float`	`getFloat(String key)` 根据key获取Float类型的值
`Float`	`getFloat(String key, Float defaultValue)` 根据key获取Float类型的值，若为null返回默认值
`String`	`getId()`
`Integer`	`getInteger(String key)` 根据key获取Integer类型的值
`Integer`	`getInteger(String key, Integer defaultValue)` 根据key获取Integer类型的值，若为null返回默认值
`Long`	`getLong(String key)` 根据key获取Long类型的值
`Long`	`getLong(String key, Long defaultValue)` 根据key获取Long类型的值，若为null返回默认值
`String`	`getName()`
`Number`	`getNumber(String key)` 根据key获取Number类型的值
`Number`	`getNumber(String key, Number defaultValue)` 根据key获取Number类型的值，若为null返回默认值
`Param`	`getParam(String paramId)` 获取一个参数
`Map<String,Param>`	`getParamMap()`
`List<Param>`	`getParams()`
`String`	`getPath()` 获取module的配置path
`String`	`getString(String key)` 根据key获取String类型的值
`String`	`getString(String key, String defaultValue)` 根据key获取String类型的值，若为null返回默认值
`void`	`setConfig(Config config)`
`void`	`setDesc(String desc)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setParamMap(Map<String,Param> paramMap)`
`void`	`setParams(List<Param> params)`
`String`	`toJson()` 转换为json字符串(格式化输出，层级为1)
`String`	`toJson(boolean isFormat, int lv)` 转换为json字符串(格式化输出)
`String`	`toString()`
`String`	`toXml()` 转换为xml字符串(格式化输出，层级为1)
`String`	`toXml(boolean isFormat, int lv)` 转换为xml字符串
`void`	`updateParam(Param param)` 更新一个参数

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Module
```
public Module(String id,
              String name,
              Config config)
```
- 方法详细资料
  - getId
```
public String getId()
```
  - setId
```
public void setId(String id)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getDesc
```
public String getDesc()
```
  - setDesc
```
public void setDesc(String desc)
```
  - getConfig
```
public Config getConfig()
```
  - setConfig
```
public void setConfig(Config config)
```
  - getParamMap
```
public Map<String,Param> getParamMap()
```
  - setParamMap
```
public void setParamMap(Map<String,Param> paramMap)
```
  - getParams
```
public List<Param> getParams()
```
  - setParams
```
public void setParams(List<Param> params)
```
  - createParam
```
public Param createParam(String paramId,
                         String paramName,
                         ParamType paramType,
                         String paramValue)
```
    为当前module创建一个param
    
    参数:
    
    paramId - param id
    
    paramName - param name
    
    paramType - param type
    
    paramValue - param value
    
    返回:
    
    被创建的param
  - addParam
```
public void addParam(Param param)
```
    添加一个参数
    
    参数:
    
    param - 需要添加的参数
  - deleteParam
```
public void deleteParam(String paramId)
```
    删除一个参数
    
    参数:
    
    paramId - 需要删除的参数id
  - updateParam
```
public void updateParam(Param param)
```
    更新一个参数
    
    参数:
    
    param - 需要更细的参数
  - getParam
```
public Param getParam(String paramId)
```
    获取一个参数
    
    参数:
    
    paramId - 参数id
    
    返回:
    
    获取到的参数, 无参数返回null
  - toJson
```
public String toJson(boolean isFormat,
                     int lv)
```
    从接口复制的说明: ToJson
    
    转换为json字符串(格式化输出)
    
    指定者:
    
    toJson 在接口中 ToJson
    
    参数:
    
    isFormat - 是否格式化输出
    
    lv - 格式化输出层级(当isFormat为true时该参数有效)
    
    返回:
    
    标准json格式字符串
  - toJson
```
public String toJson()
```
    从接口复制的说明: ToJson
    
    转换为json字符串(格式化输出，层级为1)
    
    指定者:
    
    toJson 在接口中 ToJson
    
    返回:
    
    标准json格式字符串
  - toXml
```
public String toXml(boolean isFormat,
                    int lv)
```
    从接口复制的说明: ToXml
    
    转换为xml字符串
    
    指定者:
    
    toXml 在接口中 ToXml
    
    参数:
    
    isFormat - 是否格式化输出
    
    lv - 格式化输出层级(当isFormat为true时该参数有效)
    
    返回:
    
    标准xml格式字符串
  - toXml
```
public String toXml()
```
    从接口复制的说明: ToXml
    
    转换为xml字符串(格式化输出，层级为1)
    
    指定者:
    
    toXml 在接口中 ToXml
    
    返回:
    
    标准xml格式字符串
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Module target)
```
  - getPath
```
public String getPath()
```
    获取module的配置path
    
    返回:
    
    path
  - getString
```
public String getString(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取String类型的值
    
    指定者:
    
    getString 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取String类型的值，若为null返回默认值
    
    指定者:
    
    getString 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getBoolean
```
public Boolean getBoolean(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Boolean类型的值
    
    指定者:
    
    getBoolean 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getBoolean
```
public Boolean getBoolean(String key,
                          Boolean defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Boolean类型的值，若为null返回默认值
    
    指定者:
    
    getBoolean 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getNumber
```
public Number getNumber(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Number类型的值
    
    指定者:
    
    getNumber 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getNumber
```
public Number getNumber(String key,
                        Number defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Number类型的值，若为null返回默认值
    
    指定者:
    
    getNumber 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getInteger
```
public Integer getInteger(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Integer类型的值
    
    指定者:
    
    getInteger 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getInteger
```
public Integer getInteger(String key,
                          Integer defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Integer类型的值，若为null返回默认值
    
    指定者:
    
    getInteger 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getLong
```
public Long getLong(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Long类型的值
    
    指定者:
    
    getLong 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getLong
```
public Long getLong(String key,
                    Long defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Long类型的值，若为null返回默认值
    
    指定者:
    
    getLong 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getFloat
```
public Float getFloat(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Float类型的值
    
    指定者:
    
    getFloat 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getFloat
```
public Float getFloat(String key,
                      Float defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Float类型的值，若为null返回默认值
    
    指定者:
    
    getFloat 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getDouble
```
public Double getDouble(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Double类型的值
    
    指定者:
    
    getDouble 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getDouble
```
public Double getDouble(String key,
                        Double defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Double类型的值，若为null返回默认值
    
    指定者:
    
    getDouble 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取BigDecimal类型的值
    
    指定者:
    
    getBigDecimal 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key,
                                BigDecimal defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取BigDecimal类型的值，若为null返回默认值
    
    指定者:
    
    getBigDecimal 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getDate
```
public Date getDate(String key)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Date类型的值根据参数类型、值类型、长度自动匹配对应的格式：若为Boolean类型，放弃转换，返回null 若为Number类型将去掉小数后的值作为Date.getTime值转换为date；若为String类型：当Param对象指定了datePattern则直接使用，否则若length为10，对应“yyyy-MM-dd” 若length为8，对应“HH:mm:ss” 若length为19，对应“yyyy-MM-dd HH:mm:ss” 若length为17，对应“yyyyMMddHHmmssSSS” 若为其他，无法识别，返回null
    
    指定者:
    
    getDate 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    返回:
    
    值
  - getDate
```
public Date getDate(String key,
                    Date defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key获取Date类型的值，若为null返回默认值根据参数类型、值类型、长度自动匹配对应的格式：若为Boolean类型，放弃转换，返回defaultValue 若为Number类型将去掉小数后的值作为Date.getTime值转换为date；若为String类型：当Param对象指定了datePattern则直接使用，否则若length为10，对应“yyyy-MM-dd” 若length为8，对应“HH:mm:ss” 若length为19，对应“yyyy-MM-dd HH:mm:ss” 若length为17，对应“yyyyMMddHHmmssSSS” 若为其他，无法识别，返回defaultValue
    
    指定者:
    
    getDate 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    defaultValue - defaultValue
    
    返回:
    
    值
  - getDate
```
public Date getDate(String key,
                    String datePattern)
```
    从接口复制的说明: ParamGetter
    
    根据key和指定格式化参数获取Date类型的值
    
    指定者:
    
    getDate 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    datePattern - 格式化参数
    
    返回:
    
    值
  - getDate
```
public Date getDate(String key,
                    String datePattern,
                    Date defaultValue)
```
    从接口复制的说明: ParamGetter
    
    根据key和指定格式化参数获取Date类型的值，若为null返回默认值
    
    指定者:
    
    getDate 在接口中 ParamGetter
    
    参数:
    
    key - key
    
    datePattern - 格式化参数
    
    defaultValue - defaultValue
    
    返回:
    
    值

类 Module

构造器概要

方法概要

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

构造器详细资料

Module

方法详细资料

getId

setId

getName

setName

getDesc

setDesc

getConfig

setConfig

getParamMap

setParamMap

getParams

setParams

createParam

addParam

deleteParam

updateParam

getParam

toJson

toJson

toXml

toXml

toString

equals

getPath

getString

getString

getBoolean

getBoolean

getNumber

getNumber

getInteger

getInteger

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getBigDecimal

getBigDecimal

getDate

getDate

getDate

getDate