Package cc.carm.lib.configuration.yaml

Class YAMLConfigProvider

java.lang.Object

cc.carm.lib.configuration.core.source.ConfigurationProvider<W>

cc.carm.lib.configuration.core.source.impl.FileConfigProvider<YAMLSectionWrapper>

cc.carm.lib.configuration.yaml.YAMLConfigProvider

All Implemented Interfaces:

CommentedYAML

public class YAMLConfigProvider
extends FileConfigProvider<YAMLSectionWrapper>
implements CommentedYAML

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull ConfigurationComments	comments
protected org.bspfsystems.yamlconfiguration.file.YamlConfiguration	configuration
protected ConfigInitializer<YAMLConfigProvider>	initializer

Fields inherited from class cc.carm.lib.configuration.core.source.impl.FileConfigProvider

file

Fields inherited from class cc.carm.lib.configuration.core.source.ConfigurationProvider

updateTime

Constructor Summary

Constructors

Constructor	Description
YAMLConfigProvider(@NotNull java.io.File file)

Method Summary

Modifier and Type	Method	Description
@NotNull ConfigurationComments	getComments()
@NotNull YAMLSectionWrapper	getConfiguration()	得到配置文件的原生功能类。
@Nullable java.util.List<java.lang.String>	getHeaderComments(@Nullable java.lang.String key)
@NotNull ConfigInitializer<YAMLConfigProvider>	getInitializer()
java.util.Set<java.lang.String>	getKeys(@Nullable java.lang.String sectionKey, boolean deep)
@Nullable java.lang.Object	getValue(@NotNull java.lang.String key)
void	initializeConfig()
protected void	onReload()	针对于不同配置文件类型所执行的重载操作。
void	save()	将当前对配置文件的更改进行保存。
java.lang.String	serializeValue(@NotNull java.lang.String key, @NotNull java.lang.Object value)

Methods inherited from class cc.carm.lib.configuration.core.source.impl.FileConfigProvider

getFile, getResource, initializeFile, saveResource

Methods inherited from class cc.carm.lib.configuration.core.source.ConfigurationProvider

getHeaderComment, getInlineComment, getUpdateTime, initialize, initialize, initialize, initialize, initialize, isExpired, reload, setHeaderComment, setInlineComment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cc.carm.lib.yamlcommentupdater.CommentedYAML

getInlineComment, getKeys

Field Detail

comments

@NotNull
protected final @NotNull ConfigurationComments comments

configuration

protected org.bspfsystems.yamlconfiguration.file.YamlConfiguration configuration

initializer

protected ConfigInitializer<YAMLConfigProvider> initializer

Constructor Detail

YAMLConfigProvider

public YAMLConfigProvider(@NotNull
                          @NotNull java.io.File file)

Method Detail

initializeConfig

public void initializeConfig()

getConfiguration

@NotNull
public @NotNull YAMLSectionWrapper getConfiguration()

Description copied from class: ConfigurationProvider

得到配置文件的原生功能类。

Specified by:

getConfiguration in class ConfigurationProvider<YAMLSectionWrapper>

Returns:

原生类

onReload

protected void onReload()
                 throws java.lang.Exception

Description copied from class: ConfigurationProvider

针对于不同配置文件类型所执行的重载操作。

Specified by:

onReload in class ConfigurationProvider<YAMLSectionWrapper>

Throws:

java.lang.Exception - 当操作出现错误时抛出。

getComments

@NotNull
public @NotNull ConfigurationComments getComments()

Specified by:

getComments in class ConfigurationProvider<YAMLSectionWrapper>

save

public void save()
          throws java.lang.Exception

Description copied from class: ConfigurationProvider

将当前对配置文件的更改进行保存。

Specified by:

save in class ConfigurationProvider<YAMLSectionWrapper>

Throws:

java.lang.Exception - 当保存出现错误时抛出

getInitializer

@NotNull
public @NotNull ConfigInitializer<YAMLConfigProvider> getInitializer()

Specified by:

getInitializer in class ConfigurationProvider<YAMLSectionWrapper>

serializeValue

public java.lang.String serializeValue(@NotNull
                                       @NotNull java.lang.String key,
                                       @NotNull
                                       @NotNull java.lang.Object value)

Specified by:

serializeValue in interface CommentedYAML

getKeys

public java.util.Set<java.lang.String> getKeys(@Nullable
                                               @Nullable java.lang.String sectionKey,
                                               boolean deep)

Specified by:

getKeys in interface CommentedYAML

getValue

@Nullable
public @Nullable java.lang.Object getValue(@NotNull
                                           @NotNull java.lang.String key)

Specified by:

getValue in interface CommentedYAML

getHeaderComments

@Nullable
public @Nullable java.util.List<java.lang.String> getHeaderComments(@Nullable
                                                                    @Nullable java.lang.String key)

Specified by:

getHeaderComments in interface CommentedYAML