com.codelanx.codelanxlib.data.types

Class Yaml

java.lang.Object

com.codelanx.codelanxlib.data.types.Yaml

All Implemented Interfaces:

DataType, FileDataType

public class Yaml
extends Object
implements FileDataType

Represents a YAML file that is parsed and loaded into memory.

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected File	location The location of this FileDataType
protected org.bukkit.configuration.file.FileConfiguration	yaml The underlying FileConfiguration object

Constructor Summary

Constructors

Constructor and Description
Yaml(File location) Reads and loads a YAML file into memory.

Method Summary

Modifier and Type	Method and Description
Object	get(String path) Gets the object at the specified path
Object	get(String path, Object def) Gets the object at the specified path, or returns the passed "default" value if nothing is found
org.bukkit.configuration.file.FileConfiguration	getFileConfiguration() Returns the underlying FileConfiguration used in reading the YAML file.
boolean	isSet(String path) Returns whether or not there is an object located at the specified path
void	save() Saves any information in memory to the file it was loaded from.
void	save(File target) Saves any information in memory to the file specified.
void	set(String path, Object value) Sets the value at the location specified by the passed path

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codelanx.codelanxlib.data.FileDataType

newInstance

Field Detail

location

protected final File location

The location of this FileDataType

yaml

protected final org.bukkit.configuration.file.FileConfiguration yaml

The underlying FileConfiguration object

Constructor Detail

Yaml

public Yaml(File location)

Reads and loads a YAML file into memory.

Parameters:

location - The location of the file to read

Since:

0.1.0

Method Detail

isSet

public boolean isSet(String path)

Returns whether or not there is an object located at the specified path

Specified by:

isSet in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

Returns:

true if a value is found, false otherwise

Since:

0.1.0

set

public void set(String path,
                Object value)

Sets the value at the location specified by the passed path

Specified by:

set in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

value - The value to set

Since:

0.1.0

get

public Object get(String path)

Gets the object at the specified path

Specified by:

get in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

Returns:

The object found in memory at this location, or null if nothing is found

Since:

0.1.0

get

public Object get(String path,
                  Object def)

Gets the object at the specified path, or returns the passed "default" value if nothing is found

Specified by:

get in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

def - The default value to return upon not finding a value

Returns:

The relevant object, or the default if no value is found

Since:

0.1.0

save

public void save()
          throws IOException

Saves any information in memory to the file it was loaded from.

Specified by:

save in interface FileDataType

Throws:

IOException - Any read/write locks or permission errors on the file

Since:

0.1.0

save

public void save(File target)
          throws IOException

Saves any information in memory to the file specified.

Specified by:

save in interface FileDataType

Parameters:

target - The file to save to

Throws:

IOException - Any read/write locks or permission errors on the file

Since:

0.1.0

getFileConfiguration

public org.bukkit.configuration.file.FileConfiguration getFileConfiguration()

Returns the underlying FileConfiguration used in reading the YAML file.

Returns:

The underlying FileConfiguration in use

Since:

0.1.0