org.apache.reef.tang.formats

Interface ConfigurationSerializer

All Known Implementing Classes:

AvroConfigurationSerializer

@DefaultImplementation(value=AvroConfigurationSerializer.class)
public interface ConfigurationSerializer

A base interface for Configuration serializers.

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	fromByteArray(byte[] theBytes) Loads a Configuration from a byte[] created with toByteArray().
Configuration	fromByteArray(byte[] theBytes, ClassHierarchy classHierarchy) Loads a Configuration from a byte[] created with toByteArray().
Configuration	fromFile(File file) Loads a Configuration from a File created with toFile().
Configuration	fromFile(File file, ClassHierarchy classHierarchy) Loads a Configuration from a File created with toFile().
Configuration	fromString(String theString) Decodes a String generated via toString().
Configuration	fromString(String theString, ClassHierarchy classHierarchy) Decodes a String generated via toString().
Configuration	fromTextFile(File file) Loads a Configuration from a File created with toFile().
Configuration	fromTextFile(File file, ClassHierarchy classHierarchy) Loads a Configuration from a File created with toFile() with ClassHierarchy.
byte[]	toByteArray(Configuration conf) Writes the Configuration to a byte[].
void	toFile(Configuration conf, File file) Stores the given Configuration in the given File.
String	toString(Configuration configuration) Writes the Configuration as a String.
void	toTextFile(Configuration conf, File file) Stores the given Configuration in the given Text File.

Method Detail

toFile

void toFile(Configuration conf,
          File file)
            throws IOException

Stores the given Configuration in the given File.

Parameters:

conf - the Configuration to store

file - the file to store the Configuration in

Throws:

IOException - if there is an IO error in the process.

toTextFile

void toTextFile(Configuration conf,
              File file)
                throws IOException

Stores the given Configuration in the given Text File.

Parameters:

conf - the Configuration to store

file - the file to store the Configuration in

Throws:

IOException - if there is an IO error in the process.

toByteArray

byte[] toByteArray(Configuration conf)
                   throws IOException

Writes the Configuration to a byte[].

Parameters:

conf - the Configuration to be converted

Returns:

the byte array

Throws:

IOException - if encoding fails to write

toString

String toString(Configuration configuration)

Writes the Configuration as a String.

Parameters:

configuration - the Configuration to be converted

Returns:

a String representation of the Configuration

fromFile

Configuration fromFile(File file)
                       throws IOException,
                              BindException

Loads a Configuration from a File created with toFile().

Parameters:

file - the File to read from.

Returns:

the Configuration stored in the file.

Throws:

IOException - if the File can't be read or parsed

BindException - if the file contains an illegal Configuration

fromTextFile

Configuration fromTextFile(File file)
                           throws IOException,
                                  BindException

Loads a Configuration from a File created with toFile().

Parameters:

file - the File to read from.

Returns:

the Configuration stored in the file.

Throws:

IOException - if the File can't be read or parsed

BindException - if the file contains an illegal Configuration

fromTextFile

Configuration fromTextFile(File file,
                         ClassHierarchy classHierarchy)
                           throws IOException

Loads a Configuration from a File created with toFile() with ClassHierarchy.

Parameters:

file - the File to read from.

classHierarchy - the class hierarchy to be used.

Returns:

the Configuration stored in the file.

Throws:

IOException - if the File can't be read or parsed

fromFile

Configuration fromFile(File file,
                     ClassHierarchy classHierarchy)
                       throws IOException,
                              BindException

Loads a Configuration from a File created with toFile().

Parameters:

file - the File to read from.

classHierarchy - used to validate the configuration against

Returns:

the Configuration stored in the file.

Throws:

IOException - if the File can't be read or parsed

BindException - if the file contains an illegal Configuration

fromByteArray

Configuration fromByteArray(byte[] theBytes)
                            throws IOException,
                                   BindException

Loads a Configuration from a byte[] created with toByteArray().

Parameters:

theBytes - the bytes to deserialize.

Returns:

the Configuration stored.

Throws:

IOException - if the byte[] can't be deserialized

BindException - if the byte[] contains an illegal Configuration.

fromByteArray

Configuration fromByteArray(byte[] theBytes,
                          ClassHierarchy classHierarchy)
                            throws IOException,
                                   BindException

Loads a Configuration from a byte[] created with toByteArray().

Parameters:

theBytes - the bytes to deserialize.

classHierarchy - used to validate the configuration against

Returns:

the Configuration stored.

Throws:

IOException - if the byte[] can't be deserialized

BindException - if the byte[] contains an illegal Configuration.

fromString

Configuration fromString(String theString)
                         throws IOException,
                                BindException

Decodes a String generated via toString().

Parameters:

theString - to be parsed

Returns:

the Configuration stored in theString.

Throws:

IOException - if theString can't be parsed.

BindException - if theString contains an illegal Configuration.

fromString

Configuration fromString(String theString,
                       ClassHierarchy classHierarchy)
                         throws IOException,
                                BindException

Decodes a String generated via toString().

Parameters:

theString - to be parsed

classHierarchy - used to validate the configuration against

Returns:

the Configuration stored in theString.

Throws:

IOException - if theString can't be parsed.

BindException - if theString contains an illegal Configuration.