BaseConfiguration (simple-robot-core-码云(gitee.com))

java.lang.Object
- com.forte.qqrobot.BaseConfiguration<T>

@Conf(value={"","simbot"},
      comment="\u6838\u5fc3\u4e2d\u7684\u57fa\u7840\u914d\u7f6e\u7c7b")
public class BaseConfiguration<T extends BaseConfiguration>
extends Object

配置类的根类，定义包扫描方法

Since:: JDK1.8
Author:: ForteScarlet <[163邮箱地址]ForteScarlet@163.com>

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Map.Entry<String,BotInfo>>`	`advanceBotInfo` 用于对多账号进行注册，先是只保存部分信息
`protected ConfigProperties`	`configProperties` 配置文件的读取内容如果不是配置文件的话，此类得不到任何内容。
`protected BotInfo`	`defaultBotInfo` 指定一个默认的Botinfo，没有人工指定的情况下，会默认设定为第一次注册的账号信息

Constructor Summary

Constructors
Constructor and Description

BaseConfiguration()

Constructors
Constructor and Description
`BaseConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`T`	`clearValue()` 清除额外配置
`BaseConfiguration<T>`	`clone()` Deprecated.
`String[]`	`getActive()`
`Map<String,List<BotInfo>>`	`getAdvanceBotInfo()` 获取预先注册的bot信息。
`Double`	`getBlockingFactor()`
`Boolean`	`getBotCheck()`
`Boolean`	`getCheckVersion()`
`ClassLoader`	`getClassLoader()`
`ConfigProperties`	`getConfigProperties()`
`T`	`getConfiguration()`
`Integer`	`getCorePoolSize()`
`String`	`getCqPath()`
`BotInfo`	`getDefaultBotInfo()` 获取当前记录的默认bot的信息
`ThreadFactory`	`getDefaultThreadFactory()`
`DependGetter`	`getDependGetter()` 获取依赖获取器
`Boolean`	`getEnableServer()`
`String`	`getEncode()`
`String`	`getIp()` Deprecated.
`Long`	`getKeepAliveTime()`
`Locale`	`getLanguage()`
`String`	`getLocalQQCode()` Deprecated.
`String`	`getLocalQQNick()` Deprecated.
`int`	`getLocalServerPort()`
`LoginQQInfo`	`getLoginQQInfo()` Deprecated.
`LogLevel`	`getLogLevel()`
`Integer`	`getMaximumPoolSize()`
`PathAssembler`	`getPathAssembler()` 根据当前的`toPath(String, int, String)`获取路径拼接函数
`BaseLocalThreadPool.PoolConfig`	`getPoolConfig()` 获取线程池配置对象
`ResultSelectType`	`getResultSelectType()`
`Set<String>`	`getScannerPackage()` 获取需要进行扫描的包路径集合
`TimeUnit`	`getTimeUnit()`
`Object`	`getValue(String key)` 取得额外配置
`Set<Map.Entry<String,Object>>`	`getValueEntrySet()` 获取额外配置的entry set
`BlockingQueue<Runnable>`	`getWorkQueue()` 获取线程池的阻塞队列
`String`	`getWorkQueueFrom()`
`boolean`	`isLocalServerEnable()`
`T`	`putValue(String key, Object value)` 存入额外配置
`void`	`registerBot(String path)` 仅仅注册一个路径信息，需要是一个完整路径，例如一个http路径或者一个ws的连接路径。在启动后需要通过此路径来验证或者连接。一般来说直接使用这个就行了。
`void`	`registerBot(String ip, int port, String path)` 仅注册一个路径信息，信息分为ip、端口、一个可能存在的额外路径。
`void`	`registerBot(String botCode, String path)` 注册一个机器人的信息。
`void`	`registerBot(String botCode, String ip, int port, String path)` 注册一个机器人的信息。
`void`	`registerBotAsDefault(String path)` 仅仅注册一个路径信息，需要是一个完整路径，例如一个http路径或者一个ws的连接路径。在启动后需要通过此路径来验证或者连接
`void`	`registerBotAsDefault(String ip, int port, String path)` 仅注册一个路径信息，信息分为ip、端口、一个可能存在的额外路径。
`void`	`registerBotAsDefault(String botCode, String path)` 注册一个机器人的信息。与普通的registerBot不同，此处注册的机器人会直接覆盖当前的默认机器人信息
`void`	`registerBotAsDefault(String botCode, String ip, int port, String path)` 注册一个机器人的信息。
`void`	`registerBotsFormatter(String registerBots)` 对配置文件的信息进行注册, 一般手动注册时候不需要使用此方法
`T`	`scanner(String packageName)` 包扫描，现在的扫描已经不再仅限于监听器了
`T`	`scannerListener(String packageName)` 包扫描普通监听器
`void`	`setActive(String[] active)`
`void`	`setBlockingFactor(Double blockingFactor)`
`void`	`setBotCheck(Boolean botCheck)`
`void`	`setCheckVersion(Boolean checkVersion)`
`void`	`setClassLoader(ClassLoader classLoader)`
`protected void`	`setConfigProperties(ConfigProperties configProperties)` 使用者不需要设置
`void`	`setCorePoolSize(Integer corePoolSize)`
`T`	`setCqPath(String cqPath)`
`void`	`setDefaultBotInfo(BotInfo botInfo)`
`void`	`setDefaultThreadFactory(ThreadFactory defaultThreadFactory)`
`T`	`setDependGetter(DependGetter dependGetter)` 配置依赖获取器
`T`	`setDependGetter(String packPath)` 通过类的全包路径进行指定，通过反射创建实例
`void`	`setEnableServer(Boolean enableServer)`
`T`	`setEncode(String encode)`
`T`	`setIp(String ip)` Deprecated.
`void`	`setKeepAliveTime(Long keepAliveTime)`
`void`	`setLanguage(Locale language)`
`void`	`setLanguageByTag(String tag)`
`T`	`setLocalQQCode(String localQQCode)` Deprecated.
`T`	`setLocalQQNick(String localQQNick)` Deprecated.
`T`	`setLocalServerEnable(boolean localServerEnable)`
`T`	`setLocalServerPort(int localServerPort)`
`T`	`setLoginQQInfo(LoginQQInfo loginQQInfo)` Deprecated.
`void`	`setLogLevel(LogLevel logLevel)`
`void`	`setLogLevelByName(String name)`
`void`	`setMaximumPoolSize(Integer maximumPoolSize)`
`void`	`setPoolConfig(BaseLocalThreadPool.PoolConfig poolConfig)`
`void`	`setResultSelectType(ResultSelectType resultSelectType)`
`void`	`setResultSelectTypeByName(String name)`
`T`	`setScannerPackage(String... packages)` 配置需要进行扫描的路径
`void`	`setTimeUnit(TimeUnit timeUnit)`
`void`	`setTimeUnitByName(String name)` 通过name获取枚举对象
`void`	`setWorkQueue(BlockingQueue<Runnable> workQueue)`
`void`	`setWorkQueueFrom(String workQueueFrom)`
`protected String`	`toPath(String ip, int port, String path)` 将ip、端口、后缀路径拼接为一个请求路径

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

Field Detail
- advanceBotInfo
```
protected List<Map.Entry<String,BotInfo>> advanceBotInfo
```
  用于对多账号进行注册，先是只保存部分信息
- defaultBotInfo
```
protected BotInfo defaultBotInfo
```
  指定一个默认的Botinfo，没有人工指定的情况下，会默认设定为第一次注册的账号信息
- configProperties
```
protected ConfigProperties configProperties
```
  配置文件的读取内容如果不是配置文件的话，此类得不到任何内容。

Constructor Detail
- BaseConfiguration
```
public BaseConfiguration()
```

Method Detail

clone
```
@Deprecated
public BaseConfiguration<T> clone()
```
Deprecated.

不再使用clone，保留是为了兼容

Overrides:

clone in class Object

Returns:

setResultSelectTypeByName

public void setResultSelectTypeByName(String name)

setLogLevelByName

public void setLogLevelByName(String name)

setLanguageByTag

public void setLanguageByTag(String tag)

registerBotsFormatter
```
public void registerBotsFormatter(String registerBots)
```
对配置文件的信息进行注册, 一般手动注册时候不需要使用此方法

Parameters:

registerBots - registerBots

setTimeUnitByName

public void setTimeUnitByName(String name)

通过name获取枚举对象

getWorkQueue

public BlockingQueue<Runnable> getWorkQueue()

获取线程池的阻塞队列

getPoolConfig

public BaseLocalThreadPool.PoolConfig getPoolConfig()

获取线程池配置对象

registerBot
```
public void registerBot(String botCode,
                        String path)
```
注册一个机器人的信息。

Parameters:

botCode - bot账号

path - 上报地址，为一个完整的请求路径，例如：http://127.0.0.1:12345

registerBot

public void registerBot(String botCode,
                        String ip,
                        int port,
                        String path)

注册一个机器人的信息。

Parameters:: botCode - bot账号; ip - 上报地址的ip; port - 上报地址的端口; path - 如果存在，上报地址的路径

registerBot
```
public void registerBot(String path)
```
仅仅注册一个路径信息，需要是一个完整路径，例如一个http路径或者一个ws的连接路径。在启动后需要通过此路径来验证或者连接。一般来说直接使用这个就行了。

Parameters:

path - 上报路径

registerBot

public void registerBot(String ip,
                        int port,
                        String path)

 仅注册一个路径信息，信息分为ip、端口、一个可能存在的额外路径。
  开发者如果需要实现对于ip、端口、额外路径的转化规则，尝试重写toPath(String, int, String)方法。默认情况下为转化为http协议路径。

Parameters:: ip - ip地址; port - 端口; path - nullable

registerBotAsDefault
```
public void registerBotAsDefault(String botCode,
                                 String path)
```
注册一个机器人的信息。与普通的registerBot不同，此处注册的机器人会直接覆盖当前的默认机器人信息

Parameters:

botCode - bot账号

path - 上报地址，为一个完整的请求路径

registerBotAsDefault

public void registerBotAsDefault(String botCode,
                                 String ip,
                                 int port,
                                 String path)

注册一个机器人的信息。

Parameters:: botCode - bot账号; ip - 上报地址的ip; port - 上报地址的端口; path - 如果存在，上报地址的路径

registerBotAsDefault
```
public void registerBotAsDefault(String path)
```
仅仅注册一个路径信息，需要是一个完整路径，例如一个http路径或者一个ws的连接路径。在启动后需要通过此路径来验证或者连接

Parameters:

path - 上报路径

registerBotAsDefault

public void registerBotAsDefault(String ip,
                                 int port,
                                 String path)

 仅注册一个路径信息，信息分为ip、端口、一个可能存在的额外路径。
  开发者如果需要实现对于ip、端口、额外路径的转化规则，尝试重写toPath(String, int, String)方法。默认情况下为转化为http协议路径。

Parameters:: ip - ip地址; port - 端口; path - nullable

getDefaultBotInfo
```
public BotInfo getDefaultBotInfo()
```
获取当前记录的默认bot的信息

Returns:

默认bot信息

setDefaultBotInfo

public void setDefaultBotInfo(BotInfo botInfo)

getAdvanceBotInfo

public Map<String,List<BotInfo>> getAdvanceBotInfo()

获取预先注册的bot信息。

toPath

protected String toPath(String ip,
                        int port,
                        String path)

将ip、端口、后缀路径拼接为一个请求路径

Parameters:: ip - ip地址; port - 端口; path - 路径
Returns:

getPathAssembler
```
public PathAssembler getPathAssembler()
```
根据当前的toPath(String, int, String)获取路径拼接函数

Returns:

拼接函数

scannerListener
```
public T scannerListener(String packageName)
```
包扫描普通监听器

Parameters:

packageName - 包名

scanner
```
public T scanner(String packageName)
```
包扫描，现在的扫描已经不再仅限于监听器了

setScannerPackage

public T setScannerPackage(String... packages)

配置需要进行扫描的路径

getScannerPackage
```
public Set<String> getScannerPackage()
```
获取需要进行扫描的包路径集合

getLocalQQNick
```
@Deprecated
public String getLocalQQNick()
```
Deprecated.

See Also:

registerBot(String, String), registerBot(String), registerBot(String, String, int, String), registerBot(String, int, String), registerBotAsDefault(String, String), registerBotAsDefault(String, String, int, String), registerBotAsDefault(String, int, String)

setLocalQQNick
```
@Deprecated
public T setLocalQQNick(String localQQNick)
```
Deprecated.

See Also:

registerBot(String, String), registerBot(String), registerBot(String, String, int, String), registerBot(String, int, String), registerBotAsDefault(String, String), registerBotAsDefault(String, String, int, String), registerBotAsDefault(String, int, String)

getLocalQQCode
```
@Deprecated
public String getLocalQQCode()
```
Deprecated.

See Also:

registerBot(String, String), registerBot(String), registerBot(String, String, int, String), registerBot(String, int, String), registerBotAsDefault(String, String), registerBotAsDefault(String, String, int, String), registerBotAsDefault(String, int, String)

setLocalQQCode
```
@Deprecated
public T setLocalQQCode(String localQQCode)
```
Deprecated.

See Also:

registerBot(String, String), registerBot(String), registerBot(String, String, int, String), registerBot(String, int, String), registerBotAsDefault(String, String), registerBotAsDefault(String, String, int, String), registerBotAsDefault(String, int, String)

getLoginQQInfo
```
@Deprecated
public LoginQQInfo getLoginQQInfo()
```
Deprecated.

See Also:

BotRuntime, BotManager

getEncode
```
public String getEncode()
```

setEncode
```
public T setEncode(String encode)
```

getCqPath
```
public String getCqPath()
```

setCqPath
```
public T setCqPath(String cqPath)
```

getIp
```
@Deprecated
public String getIp()
```
Deprecated.

See Also:

registerBot(String, String), registerBot(String), registerBot(String, String, int, String), registerBot(String, int, String), registerBotAsDefault(String, String), registerBotAsDefault(String, String, int, String), registerBotAsDefault(String, int, String)

setIp
```
@Deprecated
public T setIp(String ip)
```
Deprecated.

不再进行单一ip地址配置

setLoginQQInfo
```
@Deprecated
public T setLoginQQInfo(LoginQQInfo loginQQInfo)
```
Deprecated.

See Also:

registerBot(String, String), registerBot(String), registerBot(String, String, int, String), registerBot(String, int, String), registerBotAsDefault(String, String), registerBotAsDefault(String, String, int, String), registerBotAsDefault(String, int, String)

getDependGetter
```
public DependGetter getDependGetter()
```
获取依赖获取器

setDependGetter

public T setDependGetter(DependGetter dependGetter)

配置依赖获取器

setDependGetter

public T setDependGetter(String packPath)
                  throws ClassNotFoundException,
                         InstantiationException,
                         IllegalAccessException

通过类的全包路径进行指定，通过反射创建实例

Throws:: ClassNotFoundException; InstantiationException; IllegalAccessException

isLocalServerEnable
```
public boolean isLocalServerEnable()
```

setLocalServerEnable

public T setLocalServerEnable(boolean localServerEnable)

getLocalServerPort
```
public int getLocalServerPort()
```

setLocalServerPort

public T setLocalServerPort(int localServerPort)

getConfiguration
```
public final T getConfiguration()
```

getCorePoolSize
```
public Integer getCorePoolSize()
```

setCorePoolSize

public void setCorePoolSize(Integer corePoolSize)

getMaximumPoolSize
```
public Integer getMaximumPoolSize()
```

setMaximumPoolSize

public void setMaximumPoolSize(Integer maximumPoolSize)

getKeepAliveTime
```
public Long getKeepAliveTime()
```

setKeepAliveTime

public void setKeepAliveTime(Long keepAliveTime)

getTimeUnit
```
public TimeUnit getTimeUnit()
```

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

getWorkQueueFrom
```
public String getWorkQueueFrom()
```

getBlockingFactor
```
public Double getBlockingFactor()
```

setBlockingFactor

public void setBlockingFactor(Double blockingFactor)

setWorkQueueFrom

public void setWorkQueueFrom(String workQueueFrom)

setWorkQueue

public void setWorkQueue(BlockingQueue<Runnable> workQueue)

getDefaultThreadFactory

public ThreadFactory getDefaultThreadFactory()

setDefaultThreadFactory

public void setDefaultThreadFactory(ThreadFactory defaultThreadFactory)

setPoolConfig

public void setPoolConfig(BaseLocalThreadPool.PoolConfig poolConfig)

getResultSelectType

public ResultSelectType getResultSelectType()

setResultSelectType

public void setResultSelectType(ResultSelectType resultSelectType)

getLogLevel
```
public LogLevel getLogLevel()
```

setLogLevel

public void setLogLevel(LogLevel logLevel)

getLanguage
```
public Locale getLanguage()
```

setLanguage

public void setLanguage(Locale language)

getCheckVersion
```
public Boolean getCheckVersion()
```

setCheckVersion

public void setCheckVersion(Boolean checkVersion)

getEnableServer
```
public Boolean getEnableServer()
```

setEnableServer

public void setEnableServer(Boolean enableServer)

getClassLoader
```
public ClassLoader getClassLoader()
```

setClassLoader

public void setClassLoader(ClassLoader classLoader)

getConfigProperties

public ConfigProperties getConfigProperties()

getBotCheck
```
public Boolean getBotCheck()
```

setBotCheck

public void setBotCheck(Boolean botCheck)

getActive
```
public String[] getActive()
```

setActive

public void setActive(String[] active)

setConfigProperties

protected void setConfigProperties(ConfigProperties configProperties)

使用者不需要设置

Parameters:: configProperties -

putValue

public T putValue(String key,
                  Object value)

存入额外配置

Parameters:: key - key; value - value

getValue
```
public Object getValue(String key)
```
取得额外配置

Parameters:

key - key

clearValue
```
public T clearValue()
```
清除额外配置

getValueEntrySet

public Set<Map.Entry<String,Object>> getValueEntrySet()

获取额外配置的entry set

Class BaseConfiguration<T extends BaseConfiguration>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

advanceBotInfo

defaultBotInfo

configProperties

Constructor Detail

BaseConfiguration

Method Detail

clone

setResultSelectTypeByName

setLogLevelByName

setLanguageByTag

registerBotsFormatter

setTimeUnitByName

getWorkQueue

getPoolConfig

registerBot

registerBot

registerBot

registerBot

registerBotAsDefault

registerBotAsDefault

registerBotAsDefault

registerBotAsDefault

getDefaultBotInfo

setDefaultBotInfo

getAdvanceBotInfo

toPath

getPathAssembler

scannerListener

scanner

setScannerPackage

getScannerPackage

getLocalQQNick

setLocalQQNick

getLocalQQCode

setLocalQQCode

getLoginQQInfo

getEncode

setEncode

getCqPath

setCqPath

getIp

setIp

setLoginQQInfo

getDependGetter

setDependGetter

setDependGetter

isLocalServerEnable

setLocalServerEnable

getLocalServerPort

setLocalServerPort

getConfiguration

getCorePoolSize

setCorePoolSize

getMaximumPoolSize

setMaximumPoolSize

getKeepAliveTime

setKeepAliveTime

getTimeUnit

setTimeUnit

getWorkQueueFrom

getBlockingFactor

setBlockingFactor

setWorkQueueFrom

setWorkQueue

getDefaultThreadFactory

setDefaultThreadFactory

setPoolConfig

getResultSelectType

setResultSelectType

getLogLevel

setLogLevel

getLanguage

setLanguage

getCheckVersion