EmapTool (emap_pub 1.9.54.B254 API)

java.lang.Object
- com.wisedu.emap.base.core.EmapTool

所有已实现的接口:

ISysConst
```
public class EmapTool
extends Object
implements ISysConst
```
emap开发的工具类。用于获取日志对象，绑定配置属性等。

从以下版本开始:

1.4.30

字段概要

字段
限定符和类型字段和说明

static String EMAP_CONTEXT_NAME_FLAG
emap所在的应用容器名称的键值。
- 从接口继承的字段 com.wisedu.emap.base.platform.ISysConst
  ACTION_FLOW_STACK, AUTH_USER, CURRENT_APP, EC_ACTION_FAIL, EC_ALERM, EC_EMPTY_DIC, EC_FILE_DEL, EC_FILE_MD, EC_FILE_OTHER, EC_LONG_TIME, EC_NEED_INIT, EC_WRONG_FIELD, EC_WRONG_INIT, EC_WRONG_PARAM, EMAP_ACTION, EMAP_PARAM, ENVIROMENT_INFO, EXT_INFO, IGNORE, LOG_NODE, NOW_DS_SERVICE, NULL_USER, PRE_GUID, SPECIAL_OPT_OBJ, THREAD_CONTEXT, TIME_LOG, TRANSACTION_CONTAINER, UNKNOW_FLAG1

字段
限定符和类型	字段和说明
`static String`	`EMAP_CONTEXT_NAME_FLAG` emap所在的应用容器名称的键值。

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static boolean`	`addPropertyItem(String name, String item)` 向一个配置值中添加一个元素。
`static boolean`	`addPropertyItem(String name, String item, String delimiter)` 向一个配置值中添加一个元素。
`static List<self.micromagic.util.BindingError>`	`bindConfig()` 将调用此方法的类中带有Config标注的成员与配置进行自动绑定。
`static List<self.micromagic.util.BindingError>`	`bindConfig(Class<?> c)` 将指定类中带有Config标注的成员与配置进行自动绑定。
`static List<self.micromagic.util.BindingError>`	`bindConfig(Class<?> c, self.micromagic.util.PropertiesManager config)` 将指定类中Config标注的成员与指定配置进行自动绑定。
`static org.apache.commons.logging.Log`	`createCommonsLog()` 创建一个commons-logging日志。
`static org.slf4j.Logger`	`createSlf4jLogger()` 创建一个slf4j日志。
`static Class`	`getCallerClass()` 获取调用当前方法的类。
`static self.micromagic.util.PropertiesManager`	`getConfig()` 获取配置对象。
`static org.slf4j.Logger`	`getLog()` slf4j-logger。
`static String`	`getProperty(String name)` 获取配置值。
`static String`	`getProperty(String name, boolean checkNull)` 获取配置值。
`static String`	`getProperty(String name, String defaultValue)` 获取配置值。
`static void`	`initAppWorkspace(String contextName, File workspace)` 初始化应用的工作空间。
`static boolean`	`isLetter(char c)` 所给的字符是否为字母.
`static boolean`	`isValidName(String name)` 判断给出的名称是否可作为有效的变量名。
`static String`	`readProperties(InputStream stream)` 读取一个配置文件的流，处理其中的非ACSII字符转义。
`static void`	`removeProperty(String name)` 移除配置值。
`static void`	`setLoggerLevel(String logName, String level)` 设置日志记录的等级。
`static void`	`setProperty(String name, String value)` 设置配置值。
`static void`	`writeProperties(String config, OutputStream out)` 将一个配置文件写入到流，转换其中的非ACSII字符。

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

- 字段详细资料
  - EMAP_CONTEXT_NAME_FLAG
```
public static final String EMAP_CONTEXT_NAME_FLAG
```
    emap所在的应用容器名称的键值。
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - initAppWorkspace
```
public static void initAppWorkspace(String contextName,
                                    File workspace)
```
    初始化应用的工作空间。
    
    参数:
    
    contextName - 上下文根
    
    workspace - 工作目录
  - getProperty
```
public static String getProperty(String name,
                                 boolean checkNull)
```
    获取配置值。
    
    参数:
    
    name - 名称
    
    checkNull - 设为true时，如果配置值不存在会抛出异常
    
    返回:
    
    string
  - getProperty
```
public static String getProperty(String name,
                                 String defaultValue)
```
    获取配置值。
    
    参数:
    
    name - 名称
    
    defaultValue - 默认值
    
    返回:
    
    string
  - getProperty
```
public static String getProperty(String name)
```
    获取配置值。
    
    参数:
    
    name - 名称
    
    返回:
    
    string
  - setProperty
```
public static void setProperty(String name,
                               String value)
```
    设置配置值。
    
    参数:
    
    name - 名称
    
    value - 值
  - removeProperty
```
public static void removeProperty(String name)
```
    移除配置值。
    
    参数:
    
    name - 名称
  - addPropertyItem
```
public static boolean addPropertyItem(String name,
                                      String item)
```
    向一个配置值中添加一个元素。
    
    参数:
    
    name - 名称
    
    item - 元素
    
    返回:
    
    返回true表示添加成功，返回false表示无法添加或元素已存在
    
    从以下版本开始:
    
    1.8.26.B102
  - addPropertyItem
```
public static boolean addPropertyItem(String name,
                                      String item,
                                      String delimiter)
```
    向一个配置值中添加一个元素。
    
    参数:
    
    name - 名称
    
    item - 元素
    
    delimiter - 配置值中元素的分隔符
    
    返回:
    
    返回true表示添加成功，返回false表示无法添加或元素已存在
    
    从以下版本开始:
    
    1.8.26.B102
  - getConfig
```
public static self.micromagic.util.PropertiesManager getConfig()
```
    获取配置对象。
    
    返回:
    
    config
  - bindConfig
```
public static List<self.micromagic.util.BindingError> bindConfig()
```
    将调用此方法的类中带有Config标注的成员与配置进行自动绑定。
    
    返回:
    
    errors
  - bindConfig
```
public static List<self.micromagic.util.BindingError> bindConfig(Class<?> c)
```
    将指定类中带有Config标注的成员与配置进行自动绑定。
    
    参数:
    
    c - 类
    
    返回:
    
    errors
  - bindConfig
```
public static List<self.micromagic.util.BindingError> bindConfig(Class<?> c,
                                                                 self.micromagic.util.PropertiesManager config)
```
    将指定类中Config标注的成员与指定配置进行自动绑定。
    
    参数:
    
    c - 类
    
    config - 配置
    
    返回:
    
    errors
  - readProperties
```
public static String readProperties(InputStream stream)
                             throws IOException
```
    读取一个配置文件的流，处理其中的非ACSII字符转义。
    
    参数:
    
    stream - 流
    
    返回:
    
    string
    
    抛出:
    
    IOException - err
    
    从以下版本开始:
    
    1.9.4.B204
  - writeProperties
```
public static void writeProperties(String config,
                                   OutputStream out)
                            throws IOException
```
    将一个配置文件写入到流，转换其中的非ACSII字符。
    
    参数:
    
    config - 配置
    
    out - 输出流
    
    抛出:
    
    IOException - err
    
    从以下版本开始:
    
    1.9.4.B204
  - setLoggerLevel
```
public static void setLoggerLevel(String logName,
                                  String level)
```
    设置日志记录的等级。
    
    参数:
    
    logName - 日志的名称
    
    level - 日志的等级，如：INFO、WARN
    
    从以下版本开始:
    
    1.8.32.B108
  - createCommonsLog
```
public static org.apache.commons.logging.Log createCommonsLog()
```
    创建一个commons-logging日志。
    
    返回:
    
    log
  - createSlf4jLogger
```
public static org.slf4j.Logger createSlf4jLogger()
```
    创建一个slf4j日志。
    
    返回:
    
    log
  - isValidName
```
public static boolean isValidName(String name)
```
    判断给出的名称是否可作为有效的变量名。
    
    参数:
    
    name - 名称
    
    返回:
    
    boolean
  - isLetter
```
public static boolean isLetter(char c)
```
    所给的字符是否为字母.
    
    参数:
    
    c - 字符
    
    返回:
    
    boolean
  - getCallerClass
```
public static Class getCallerClass()
```
    获取调用当前方法的类。
    
    返回:
    
    类
  - getLog
```
public static org.slf4j.Logger getLog()
```
    slf4j-logger。
    
    返回:
    
    log

类 EmapTool

字段概要

从接口继承的字段 com.wisedu.emap.base.platform.ISysConst

方法概要

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

字段详细资料

EMAP_CONTEXT_NAME_FLAG

方法详细资料

initAppWorkspace

getProperty

getProperty

getProperty

setProperty

removeProperty

addPropertyItem

addPropertyItem

getConfig

bindConfig

bindConfig

bindConfig

readProperties

writeProperties

setLoggerLevel

createCommonsLog

createSlf4jLogger

isValidName

isLetter

getCallerClass

getLog