Cfgs (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.configuration.Cfgs

All Implemented Interfaces:

AutoCloseable, IConfig, IDestroyable
```
public final class Cfgs
extends Object
implements IConfig
```
配置体系管理器

Author:

刘镇 (suninformation@163.com) on 2011-8-27 上午02:17:46

Field Summary
- Fields inherited from interface net.ymate.platform.core.configuration.IConfig
  MODULE_NAME, MODULES_FOLDER_NAME, PROJECTS_FOLDER_NAME, YMP_CONFIG_HOME

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`<T extends IConfiguration> T`	`fillCfg(Class<? extends IConfigurationProvider> providerClass, T configObject, String cfgFileName, boolean search)` 根据自定义配置提供者填充配置对象
`<T extends IConfiguration> T`	`fillCfg(Class<? extends IConfigurationProvider> providerClass, T configObject, String cfgFileName, boolean search, boolean reload)` 根据自定义配置提供者填充配置对象
`<T extends IConfiguration> T`	`fillCfg(T configObject)` 填充配置对象
`<T extends IConfiguration> T`	`fillCfg(T configObject, boolean search)` 装载配置，根据Configuration注解指定的配置文件进行加载，否则默认使用当前配置类对象的SimpleName作为配置文件名，即：SimpleName.CfgTagName.xml
`<T extends IConfiguration> T`	`fillCfg(T configObject, String cfgFileName)` 填充配置对象
`<T extends IConfiguration> T`	`fillCfg(T configObject, String cfgFileName, boolean search)` 填充配置对象
`static IConfig`	`get()`
`String`	`getConfigHome()` 配置体系主目录路径
`String`	`getModuleHome()` 模块主目录路径
`String`	`getModuleName()` 模块名称
`String`	`getProjectHome()` 项目主目录路径
`String`	`getProjectName()` 项目名称
`String`	`getUserDir()` 系统变量 user.dir 值
`String`	`getUserHome()` 系统变量 user.home 值
`void`	`initialize()` 初始化
`boolean`	`isInitialized()` 是否已初始化
`IConfiguration`	`loadCfg(String cfgFileName)` 根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null
`IConfiguration`	`loadCfg(String cfgFileName, boolean search)` 根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null
`File`	`searchAsFile(String cfgFile)` 按照模块路径->项目路径->主路径(CONFIG_HOME)->用户路径(user.dir)->系统用户路径(user.home)的顺序寻找指定文件
`String`	`searchAsPath(String cfgFile)` 搜索配置文件真实资源路径，先在配置体系中查找，再到项目 CLASSPATH 路径中查找，若 cfgFile 以 "jar:" 开头则直接返回
`InputStream`	`searchAsStream(String cfgFile)` 按照模块路径的顺序寻找指定文件, 若文件存在则返回该文件输入流

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - get
```
public static IConfig get()
```
  - initialize
```
public void initialize()
                throws Exception
```
    Description copied from interface: IConfig
    
    初始化
    
    Specified by:
    
    initialize in interface IConfig
    
    Throws:
    
    Exception - 初始过程中产生的任何异常
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: IConfig
    
    是否已初始化
    
    Specified by:
    
    isInitialized in interface IConfig
    
    Returns:
    
    返回true表示已初始化
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - getConfigHome
```
public String getConfigHome()
```
    Description copied from interface: IConfig
    
    配置体系主目录路径
    
    Specified by:
    
    getConfigHome in interface IConfig
    
    Returns:
    
    返回配置体系主目录路径
  - getProjectName
```
public String getProjectName()
```
    Description copied from interface: IConfig
    
    项目名称
    
    Specified by:
    
    getProjectName in interface IConfig
    
    Returns:
    
    返回项目名称
  - getProjectHome
```
public String getProjectHome()
```
    Description copied from interface: IConfig
    
    项目主目录路径
    
    Specified by:
    
    getProjectHome in interface IConfig
    
    Returns:
    
    返回项目主目录路径
  - getModuleName
```
public String getModuleName()
```
    Description copied from interface: IConfig
    
    模块名称
    
    Specified by:
    
    getModuleName in interface IConfig
    
    Returns:
    
    返回模块名称
  - getModuleHome
```
public String getModuleHome()
```
    Description copied from interface: IConfig
    
    模块主目录路径
    
    Specified by:
    
    getModuleHome in interface IConfig
    
    Returns:
    
    返回模块主目录路径
  - getUserHome
```
public String getUserHome()
```
    Description copied from interface: IConfig
    
    系统变量 user.home 值
    
    Specified by:
    
    getUserHome in interface IConfig
    
    Returns:
    
    返回系统变量 user.home 值
  - getUserDir
```
public String getUserDir()
```
    Description copied from interface: IConfig
    
    系统变量 user.dir 值
    
    Specified by:
    
    getUserDir in interface IConfig
    
    Returns:
    
    返回系统变量 user.dir 值
  - searchAsPath
```
public String searchAsPath(String cfgFile)
```
    Description copied from interface: IConfig
    
    搜索配置文件真实资源路径，先在配置体系中查找，再到项目 CLASSPATH 路径中查找，若 cfgFile 以 "jar:" 开头则直接返回
    
    Specified by:
    
    searchAsPath in interface IConfig
    
    Parameters:
    
    cfgFile - 配置文件相对路径及名称
    
    Returns:
    
    配置文件真实路径
  - searchAsFile
```
public File searchAsFile(String cfgFile)
```
    Description copied from interface: IConfig
    
    按照模块路径->项目路径->主路径(CONFIG_HOME)->用户路径(user.dir)->系统用户路径(user.home)的顺序寻找指定文件
    
    Specified by:
    
    searchAsFile in interface IConfig
    
    Parameters:
    
    cfgFile - 配置文件路径及名称
    
    Returns:
    
    找到的文件File对象，只要找到存在的File，立即停止寻找并返回当前File实例
  - searchAsStream
```
public InputStream searchAsStream(String cfgFile)
```
    Description copied from interface: IConfig
    
    按照模块路径的顺序寻找指定文件, 若文件存在则返回该文件输入流
    
    Specified by:
    
    searchAsStream in interface IConfig
    
    Parameters:
    
    cfgFile - 配置文件路径及名称
    
    Returns:
    
    返回配置文件输入流
  - loadCfg
```
public IConfiguration loadCfg(String cfgFileName,
                              boolean search)
```
    Description copied from interface: IConfig
    
    根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null
    
    Specified by:
    
    loadCfg in interface IConfig
    
    Parameters:
    
    cfgFileName - 配置所需要的装载参数
    
    search - 是否采用搜索
    
    Returns:
    
    返回配置对象
  - loadCfg
```
public IConfiguration loadCfg(String cfgFileName)
```
    Description copied from interface: IConfig
    
    根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null
    
    Specified by:
    
    loadCfg in interface IConfig
    
    Parameters:
    
    cfgFileName - 配置所需要的装载参数
    
    Returns:
    
    返回配置对象
  - fillCfg
```
public <T extends IConfiguration> T fillCfg(T configObject,
                                            String cfgFileName)
```
    Description copied from interface: IConfig
    
    填充配置对象
    
    Specified by:
    
    fillCfg in interface IConfig
    
    Type Parameters:
    
    T - 目标对象类型
    
    Parameters:
    
    configObject - 配置对象，不可为空
    
    cfgFileName - 配置所需要的装载参数
    
    Returns:
    
    是否成功装载配置
  - fillCfg
```
public <T extends IConfiguration> T fillCfg(T configObject,
                                            String cfgFileName,
                                            boolean search)
```
    Description copied from interface: IConfig
    
    填充配置对象
    
    Specified by:
    
    fillCfg in interface IConfig
    
    Type Parameters:
    
    T - 目标对象类型
    
    Parameters:
    
    configObject - 配置对象，不可为空
    
    cfgFileName - 配置所需要的装载参数
    
    search - 是否采用搜索
    
    Returns:
    
    是否成功装载配置
  - fillCfg
```
public <T extends IConfiguration> T fillCfg(T configObject)
```
    Description copied from interface: IConfig
    
    填充配置对象
    
    Specified by:
    
    fillCfg in interface IConfig
    
    Type Parameters:
    
    T - 目标对象类型
    
    Parameters:
    
    configObject - 配置对象，不可为空
    
    Returns:
    
    是否成功装载配置
  - fillCfg
```
public <T extends IConfiguration> T fillCfg(T configObject,
                                            boolean search)
```
    Description copied from interface: IConfig
    
    装载配置，根据Configuration注解指定的配置文件进行加载，否则默认使用当前配置类对象的SimpleName作为配置文件名，即：SimpleName.CfgTagName.xml
    
    Specified by:
    
    fillCfg in interface IConfig
    
    Type Parameters:
    
    T - 目标对象类型
    
    Parameters:
    
    configObject - 配置对象，不可为空
    
    search - 是否采用搜索
    
    Returns:
    
    是否成功装载配置
  - fillCfg
```
public <T extends IConfiguration> T fillCfg(Class<? extends IConfigurationProvider> providerClass,
                                            T configObject,
                                            String cfgFileName,
                                            boolean search)
```
    Description copied from interface: IConfig
    
    根据自定义配置提供者填充配置对象
    
    Specified by:
    
    fillCfg in interface IConfig
    
    Type Parameters:
    
    T - 目标对象类型
    
    Parameters:
    
    providerClass - 配置提供者类对象，若为空则采用框架默认
    
    configObject - 配置对象，不可为空
    
    cfgFileName - 配置所需要的装载参数
    
    search - 是否采用搜索
    
    Returns:
    
    是否成功装载配置
  - fillCfg
```
public <T extends IConfiguration> T fillCfg(Class<? extends IConfigurationProvider> providerClass,
                                            T configObject,
                                            String cfgFileName,
                                            boolean search,
                                            boolean reload)
```
    Description copied from interface: IConfig
    
    根据自定义配置提供者填充配置对象
    
    Specified by:
    
    fillCfg in interface IConfig
    
    Type Parameters:
    
    T - 目标对象类型
    
    Parameters:
    
    providerClass - 配置提供者类对象，若为空则采用框架默认
    
    configObject - 配置对象，不可为空
    
    cfgFileName - 配置所需要的装载参数
    
    search - 是否采用搜索
    
    reload - 是否自动重新加载
    
    Returns:
    
    是否成功装载配置

Class Cfgs

Field Summary

Fields inherited from interface net.ymate.platform.core.configuration.IConfig

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

initialize

isInitialized

close

getConfigHome

getProjectName

getProjectHome

getModuleName

getModuleHome

getUserHome

getUserDir

searchAsPath

searchAsFile

searchAsStream

loadCfg

loadCfg

fillCfg

fillCfg

fillCfg

fillCfg

fillCfg

fillCfg