Package org.spongepowered.api.data.persistence

Interface DataFormat

All Superinterfaces:

DefaultedRegistryValue<DataFormat>

All Known Subinterfaces:

StringDataFormat

@CatalogedBy(DataFormats.class)
public interface DataFormat
extends DefaultedRegistryValue<DataFormat>

Represents a parser for a particular file format allowing reading and writing a DataContainer to/from a stream of the specific format.

Method Summary

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

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

asDefaultedReference, findKey, key

Method Details

readFrom

DataContainer readFrom(InputStream input)
                throws InvalidDataFormatException,
IOException

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

Parameters:

input - The input stream

Returns:

A data container representing the contents of the input stream

Throws:

InvalidDataFormatException - If the data in the stream was not a supported format

IOException - If there was an error reading from the stream

writeTo

void writeTo(OutputStream output,
 DataView data)
      throws IOException

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

Parameters:

output - The output stream to write the data to

data - The DataView to write to the stream

Throws:

IOException - If there was an error writing to the stream