com.codelanx.codelanxlib.data

Interface FileDataType

All Superinterfaces:

DataType

All Known Implementing Classes:

Json, Yaml

public interface FileDataType
extends DataType

Opens and loads a file into memory using the appropriate data type. This data type should have a single-argument constructor which takes a File argument.

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

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
boolean	isSet(String path) Returns whether or not there is an object located at the specified path
static <T extends FileDataType> T	newInstance(Class<T> clazz, File location) Returns a new instance of a FileDataType based on the passed class instance.
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

Method Detail

set

void set(String path,
         Object value)

Sets the value at the location specified by the passed path

Parameters:

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

value - The value to set

Since:

0.1.0

isSet

boolean isSet(String path)

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

Parameters:

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

Returns:

true if a value is found, false otherwise

Since:

0.1.0

get

Object get(String path)

Gets the object at the specified path

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

Object get(String path,
           Object def)

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

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

void save()
   throws IOException

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

Throws:

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

Since:

0.1.0

save

void save(File target)
   throws IOException

Saves any information in memory to the file specified.

Parameters:

target - The file to save to

Throws:

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

Since:

0.1.0

newInstance

static <T extends FileDataType> T newInstance(Class<T> clazz,
                                              File location)

Returns a new instance of a FileDataType based on the passed class instance.

Type Parameters:

T - Represents the type that implements FileDataType

Parameters:

clazz - The class object to be used for a new instance

location - The location of the file to parse and use

Returns:

The new instance of the requested FileDataType

Since:

0.1.0