org.epics.pvmanager.file

Interface FileFormat

All Known Implementing Classes:

CSVFileFormat, ImageFileFormat, JVTypeFileFormat, ListFileFormat

public interface FileFormat

A way to read and write an object with a particular file format.

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getFileExtensions() The file extensions supported by this file format.
boolean	isWriteSupported() Whether writes are supported.
Object	readValue(InputStream in) Reads the value from the given stream.
void	writeValue(Object value, OutputStream out) Write the value to the given stream.

Method Detail

readValue

Object readValue(InputStream in)
                 throws Exception

Reads the value from the given stream.

Parameters:

in - a stream; not null

Returns:

the value de-serialized

Throws:

Exception - any error

writeValue

void writeValue(Object value,
              OutputStream out)
                throws Exception

Write the value to the given stream.

Parameters:

value - the value to write; not null

out - the output stream; not null

Throws:

Exception - any error

isWriteSupported

boolean isWriteSupported()

Whether writes are supported.

Returns:

true if can serialize objects

getFileExtensions

Collection<String> getFileExtensions()

The file extensions supported by this file format.

Returns:

a non-empty set of file extensions