ga.strikepractice.config

Class StrikeConfig

java.lang.Object

YamlDocument

ga.strikepractice.config.StrikeConfig

public final class StrikeConfig
extends YamlDocument

Constructor Summary

Constructors

Constructor and Description
StrikeConfig(@NotNull java.io.File document, @Nullable java.io.InputStream defaults) Constructs a new instance of StrikeConfig.
StrikeConfig(@NotNull java.io.File document, @Nullable java.io.InputStream defaults, boolean autoUpdate) Constructs a new instance of StrikeConfig.

Method Summary

Modifier and Type	Method and Description
boolean	reload() Reloads the configuration from the associated YAML file.
boolean	reload(java.lang.String message) Reloads the configuration from the associated YAML file with an optional custom error message.
boolean	save() Saves the current configuration to the associated YAML file.
boolean	save(java.lang.String message) Saves the current configuration to the associated YAML file with an optional custom error message.

Methods inherited from class java.lang.Object

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

Constructor Detail

StrikeConfig

public StrikeConfig(@NotNull
                    @NotNull java.io.File document,
                    @Nullable
                    @Nullable java.io.InputStream defaults)
             throws java.io.IOException

Constructs a new instance of StrikeConfig.

Parameters:

document - The YAML configuration file to be loaded or created.

defaults - An optional input stream containing default configuration data. This data is used if the specified configuration file is not found.

Throws:

java.io.IOException - Thrown if there are issues reading or creating the configuration file.

StrikeConfig

public StrikeConfig(@NotNull
                    @NotNull java.io.File document,
                    @Nullable
                    @Nullable java.io.InputStream defaults,
                    boolean autoUpdate)
             throws java.io.IOException

Constructs a new instance of StrikeConfig.

Parameters:

document - The YAML configuration file to be loaded or created.

defaults - An optional input stream containing default configuration data. This data is used if the specified configuration file is not found.

Throws:

java.io.IOException - Thrown if there are issues reading or creating the configuration file.

Method Detail

save

public boolean save()

Saves the current configuration to the associated YAML file.

Returns:

true if the save operation is successful, otherwise false.

save

public boolean save(java.lang.String message)

Saves the current configuration to the associated YAML file with an optional custom error message.

Parameters:

message - Custom error message to be included in case of an exception.

Returns:

true if the save operation is successful, otherwise a RuntimeException is thrown with the specified error message.

reload

public boolean reload()

Reloads the configuration from the associated YAML file.

Returns:

true if the reload operation is successful, otherwise a RuntimeException is thrown with a default error message.

reload

public boolean reload(java.lang.String message)

Reloads the configuration from the associated YAML file with an optional custom error message.

Parameters:

message - Custom error message to be included in case of an exception.

Returns:

true if the reload operation is successful, otherwise a RuntimeException is thrown with the specified error message.