com.codelanx.commons.data.types

Class XML

java.lang.Object

com.codelanx.commons.data.FileDataType

com.codelanx.commons.data.types.XML

All Implemented Interfaces:

DataType

public class XML
extends FileDataType

Created by Rogue on 1/18/16.

Field Summary

Fields inherited from class com.codelanx.commons.data.FileDataType

DEBUG_SERIALIZATION, fileLock, location, NEWLINE

Constructor Summary

Constructors

Constructor and Description
XML()
XML(File location)

Method Summary

Modifier and Type	Method and Description
Object	deserializeArray(Object array)
Map<String,Object>	getRoot() The root node of this FileDataType
protected Map<String,Object>	newSection()
protected 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.
Object	serializeArray(Object array)
Object	serializeMap(Map<String,Object> toFileFormat)
protected String	toString(Map<String,Object> section)

Methods inherited from class com.codelanx.commons.data.FileDataType

deserializeMap, fromString, get, get, getMutable, getMutable, isSet, newInstance, parseDeserializable, parseSerializable, readRaw, serializationCopy, set

Methods inherited from class java.lang.Object

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

Constructor Detail

XML

public XML(File location)

XML

public XML()

Method Detail

save

public void save()
          throws IOException

Description copied from class: FileDataType

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

Overrides:

save in class FileDataType

Throws:

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

save

public void save(File target)
          throws IOException

Description copied from class: FileDataType

Saves any information in memory to the file specified.

Overrides:

save in class FileDataType

Parameters:

target - The file to save to

Throws:

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

readRaw

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

Description copied from class: FileDataType

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

Specified by:

readRaw in class FileDataType

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

public Object serializeMap(Map<String,Object> toFileFormat)

Specified by:

serializeMap in class FileDataType

serializeArray

public Object serializeArray(Object array)

Specified by:

serializeArray in class FileDataType

deserializeArray

public Object deserializeArray(Object array)

Specified by:

deserializeArray in class FileDataType

newSection

protected Map<String,Object> newSection()

Specified by:

newSection in class FileDataType

getRoot

public Map<String,Object> getRoot()

Description copied from class: FileDataType

The root node of this FileDataType

Overrides:

getRoot in class FileDataType

Returns:

The root Map that represents this FileDataType

toString

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

Specified by:

toString in class FileDataType