ConfigWrapper

java.lang.Object

wtf.choco.veinminer.util.ConfigWrapper

public final class ConfigWrapper extends Object

A simple wrapper to more easily handle YamlConfiguration instances.

Constructor Summary

Constructors

Constructor

Description

ConfigWrapper(@NotNull JavaPlugin plugin, @NotNull File directory, @NotNull String name)

Construct a new ConfigWrapper.

ConfigWrapper(@NotNull JavaPlugin plugin, @NotNull String path)

Construct a new ConfigWrapper.
Method Summary

Modifier and Type

Method

Description

@NotNull FileConfiguration

asRawConfig()

Get this ConfigWrapper as a raw FileConfiguration instance.

void

reload()

Reload values from file into memory.

void

save()

Save this ConfigWrapper.

void

saveExceptionally()

Save this ConfigWrapper and throw an IOException if one occurs according to FileConfiguration.save(File).

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

Constructor Details
- ConfigWrapper
  
  public ConfigWrapper(@NotNull @NotNull JavaPlugin plugin, @NotNull @NotNull File directory, @NotNull @NotNull String name)
  
  Construct a new ConfigWrapper.
  
  Parameters:
  
  plugin - the plugin instance
  
  directory - the directory at which the config is located
  
  name - the name of the config file
- ConfigWrapper
  
  public ConfigWrapper(@NotNull @NotNull JavaPlugin plugin, @NotNull @NotNull String path)
  
  Construct a new ConfigWrapper.
  
  Parameters:
  
  plugin - the plugin instance
  
  path - the path at which the config is located
Method Details
- asRawConfig
  
  @NotNull public @NotNull FileConfiguration asRawConfig()
  
  Get this ConfigWrapper as a raw FileConfiguration instance.
  
  Returns:
  
  the raw config
- saveExceptionally
  
  public void saveExceptionally() throws IOException
  
  Save this ConfigWrapper and throw an IOException if one occurs according to FileConfiguration.save(File).
  
  Throws:
  
  IOException - if an IOException is thrown by FileConfiguration.save(File)
- save
  
  public void save()
  
  Save this ConfigWrapper.
- reload
  
  public void reload()
  
  Reload values from file into memory.