Package org.spongepowered.api.data.persistence

Interface StringDataFormat

All Superinterfaces:

DataFormat, DefaultedRegistryValue

public interface StringDataFormat
extends DataFormat

Represents a DataFormat that reads and writes data from/to a string.

Method Summary

Modifier and Type	Method	Description
DataContainer	read(String input)	Creates a new DataContainer from the contents of the given String.
DataContainer	readFrom(Reader input)	Creates a new DataContainer from the contents of the given Reader.
String	write(DataView data)	Serializes the given DataView to a String using the format specified by this DataFormat.
void	writeTo(Writer output, DataView data)	Writes the given DataView to the given Writer using the format specified by this DataFormat.

Methods inherited from interface org.spongepowered.api.data.persistence.DataFormat

readFrom, writeTo

Methods inherited from interface org.spongepowered.api.registry.DefaultedRegistryValue

asDefaultedReference, findKey, key

Method Detail

read

DataContainer read(String input)
            throws InvalidDataException,
                   IOException

Creates a new DataContainer from the contents of the given String.

Parameters:

input - The string to parse

Returns:

A data container representing the parsed contents of the string

Throws:

InvalidDataException - If the data in the string was not a supported format

IOException - If there was an error reading from the string

readFrom

DataContainer readFrom(Reader input)
                throws InvalidDataException,
                       IOException

Creates a new DataContainer from the contents of the given Reader.

Parameters:

input - The reader

Returns:

A data container representing the parsed contents of the reader

Throws:

InvalidDataException - If the data in the reader was not a supported format

IOException - If there was an error reading from the reader

write

String write(DataView data)
      throws IOException

Serializes the given DataView to a String using the format specified by this DataFormat.

Parameters:

data - The DataView to write

Returns:

The serialized data view

Throws:

IOException - If there was an error serializing the data

writeTo

void writeTo(Writer output,
             DataView data)
      throws IOException

Writes the given DataView to the given Writer using the format specified by this DataFormat.

Parameters:

output - The writer to write the data to

data - The DataView to write to the writer

Throws:

IOException - If there was an error writing to the writer