Package ch.njol.skript.config

Class Config

java.lang.Object

ch.njol.skript.config.Config

All Implemented Interfaces:

Comparable<Config>

public class Config
extends Object
implements Comparable<Config>

Represents a config file.

Constructor Summary

Constructors

Constructor	Description
Config(File file, boolean simple, boolean allowEmptySections, String defaultSeparator)
Config(InputStream source, String fileName, boolean simple, boolean allowEmptySections, String defaultSeparator)
Config(InputStream source, String fileName, @Nullable File file, boolean simple, boolean allowEmptySections, String defaultSeparator)
Config(String s, String fileName, boolean simple, boolean allowEmptySections, String defaultSeparator)	For testing
Config(Path file, boolean simple, boolean allowEmptySections, String defaultSeparator)

Method Summary

Modifier and Type	Method	Description
int	compareTo(@Nullable Config other)
boolean	compareValues(Config other, String... excluded)	Compares the keys and values of this Config and another.
@Nullable String	get(String... path)	Gets an entry node's value at the designated path
@Nullable String	getByPath(String path)	Splits the given path at the dot character and passes the result to get(String...).
@Nullable File	getFile()
String	getFileName()
SectionNode	getMainNode()
@Nullable Path	getPath()
String	getSaveSeparator()
String	getSeparator()
boolean	isEmpty()
void	load(Class<?> c)	Sets all static Option fields of the given class to the values from this config
void	load(Object o)	Sets all Option fields of the given object to the values from this config
void	save(File f)	Saves the config to a file.
boolean	setValues(Config other)	Sets this config's values to those in the given config.
boolean	setValues(Config other, String... excluded)
HashMap<String,String>	toMap(String separator)
boolean	validate(SectionValidator validator)

Methods inherited from class java.lang.Object

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

Constructor Details

Config

public Config(InputStream source,
 String fileName,
 @Nullable
 @Nullable File file,
 boolean simple,
 boolean allowEmptySections,
 String defaultSeparator)
       throws IOException

Throws:

IOException

Config

public Config(InputStream source,
 String fileName,
 boolean simple,
 boolean allowEmptySections,
 String defaultSeparator)
       throws IOException

Throws:

IOException

Config

public Config(File file,
 boolean simple,
 boolean allowEmptySections,
 String defaultSeparator)
       throws IOException

Throws:

IOException

Config

public Config(Path file,
 boolean simple,
 boolean allowEmptySections,
 String defaultSeparator)
       throws IOException

Throws:

IOException

Config

public Config(String s,
 String fileName,
 boolean simple,
 boolean allowEmptySections,
 String defaultSeparator)
       throws IOException

For testing

Parameters:

s -

fileName -

simple -

allowEmptySections -

defaultSeparator -

Throws:

IOException

Method Details

getMainNode

public SectionNode getMainNode()

getFileName

public String getFileName()

save

public void save(File f)
          throws IOException

Saves the config to a file.

Parameters:

f - The file to save to

Throws:

IOException - If the file could not be written to.

setValues

public boolean setValues(Config other)

Sets this config's values to those in the given config.

Used by Skript to import old settings into the updated config. The return value is used to not modify the config if no new options were added.

Parameters:

other -

Returns:

Whether the configs' keys differ, i.e. false == configs only differ in values, not keys.

setValues

public boolean setValues(Config other,
 String... excluded)

compareValues

public boolean compareValues(Config other,
 String... excluded)

Compares the keys and values of this Config and another.

Parameters:

other - The other Config.

excluded - Keys to exclude from this comparison.

Returns:

True if there are differences in the keys and their values of this Config and the other Config.

getFile

@Nullable
public @Nullable File getFile()

getPath

@Nullable
public @Nullable Path getPath()

getSeparator

public String getSeparator()

Returns:

The most recent separator. Only useful while the file is loading.

getSaveSeparator

public String getSaveSeparator()

Returns:

A separator string useful for saving, e.g. ": " or " = ".

getByPath

@Nullable
public @Nullable String getByPath(String path)

Splits the given path at the dot character and passes the result to get(String...).

Parameters:

path -

Returns:

get(path.split("\\."))

get

@Nullable
public @Nullable String get(String... path)

Gets an entry node's value at the designated path

Parameters:

path -

Returns:

The entry node's value at the location defined by path or null if it either doesn't exist or is not an entry.

isEmpty

public boolean isEmpty()

toMap

public HashMap<String,String> toMap(String separator)

validate

public boolean validate(SectionValidator validator)

load

public void load(Object o)

Sets all Option fields of the given object to the values from this config

load

public void load(Class<?> c)

Sets all static Option fields of the given class to the values from this config

compareTo

public int compareTo(@Nullable
 @Nullable Config other)

Specified by:

compareTo in interface Comparable<Config>