com.codelanx.commons.data

Class FileDataType

java.lang.Object

com.codelanx.commons.data.FileDataType

All Implemented Interfaces:

DataType

Direct Known Subclasses:

Json, XML, Yaml

public abstract class FileDataType
extends Object
implements 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

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEBUG_SERIALIZATION
protected ReadWriteLock	fileLock
protected File	location The File location of this FileDataType
protected static String	NEWLINE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileDataType(File location)

Method Summary

Modifier and Type	Method and Description
protected abstract Object	deserializeArray(Object array)
protected Object	deserializeMap(Map<String,Object> data)
static Class<? extends FileDataType>	fromString(String in) Returns a Class value representative of a FileDataType, or null if none is matched
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
ConfigFile	getMutable(String path)
ConfigFile	getMutable(String path, Object def)
Map<String,Object>	getRoot() Deprecated. Public as convenience, may not be exposed when more proper api comes around (key iteration)
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.
protected abstract Map<String,Object>	newSection()
protected Object	parseDeserializable(Object o)
Object	parseSerializable(Object o)
protected Map<String,Object>	readRaw() Reads all the information currently saved in the file, disregarding any changes in memory
protected abstract Map<String,Object>	readRaw(File target) Reads all the information currently saved in the file, disregarding any changes in memory
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.
protected Map<String,Object>	serializationCopy(Map<String,Object> original)
protected abstract Object	serializeArray(Object array)
protected abstract Object	serializeMap(Map<String,Object> toFileFormat)
void	set(String path, Object value) Sets the value at the location specified by the passed path
protected abstract String	toString(Map<String,Object> section)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_SERIALIZATION

protected static final boolean DEBUG_SERIALIZATION

See Also:

Constant Field Values

NEWLINE

protected static final String NEWLINE

fileLock

protected final ReadWriteLock fileLock

location

protected final File location

The File location of this FileDataType

Constructor Detail

FileDataType

protected FileDataType(File location)

Method Detail

set

public 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

public 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

public 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

getMutable

public ConfigFile getMutable(String path)

getMutable

public ConfigFile getMutable(String path,
                             Object def)

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

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.

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.

Parameters:

target - The file to save to

Throws:

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

Since:

0.1.0

newInstance

public 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

parseSerializable

public final Object parseSerializable(Object o)

parseDeserializable

protected final Object parseDeserializable(Object o)

serializationCopy

protected final Map<String,Object> serializationCopy(Map<String,Object> original)

deserializeMap

protected final Object deserializeMap(Map<String,Object> data)

readRaw

protected Map<String,Object> readRaw()
                              throws IOException

Reads all the information currently saved in the file, disregarding any changes in memory

Returns:

The raw Map<String, Object> value of the file. This method must return an empty Map<String, Object> if the file is empty or a reader returns null.

Throws:

IOException - If the file could not be read

readRaw

protected abstract Map<String,Object> readRaw(File target)
                                       throws IOException

Reads all the information currently saved in the file, disregarding any changes in memory

Parameters:

target - The File to be read

Returns:

The raw Map<String, Object> value of the target File This method must return an empty Map<String, Object> if the file is empty or a reader returns null.

Throws:

IOException - If the file could not be read

serializeMap

protected abstract Object serializeMap(Map<String,Object> toFileFormat)

serializeArray

protected abstract Object serializeArray(Object array)

deserializeArray

protected abstract Object deserializeArray(Object array)

newSection

protected abstract Map<String,Object> newSection()

fromString

public static Class<? extends FileDataType> fromString(String in)

Returns a Class value representative of a FileDataType, or null if none is matched

Parameters:

in - The string to parse

Returns:

A relevant FileDataType class, or null

Since:

0.1.0

getRoot

public Map<String,Object> getRoot()

Deprecated. Public as convenience, may not be exposed when more proper api comes around (key iteration)

The root node of this FileDataType

Returns:

The root Map that represents this FileDataType

Since:

0.3.2

toString

protected abstract String toString(Map<String,Object> section)