org.apache.reef.tang.formats

Class AvroConfigurationSerializer

java.lang.Object

org.apache.reef.tang.formats.AvroConfigurationSerializer

All Implemented Interfaces:

ConfigurationSerializer

public final class AvroConfigurationSerializer
extends Object
implements ConfigurationSerializer

(De-)Serializing Configuration to and from AvroConfiguration.

This class is stateless and is therefore safe to reuse.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CS
static String	JAVA

Constructor Summary

Constructors

Constructor and Description
AvroConfigurationSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
void	configurationBuilderFromString(String theString, ConfigurationBuilder configBuilder) Converts a given serialized string to ConfigurationBuilder from which Configuration can be produced.
Configuration	fromAvro(AvroConfiguration avroConfiguration) Converts a given AvroConfiguration to Configuration.
Configuration	fromAvro(AvroConfiguration avroConfiguration, ClassHierarchy classHierarchy) Converts a given AvroConfiguration to Configuration.
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.
AvroConfiguration	toAvro(Configuration configuration)
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.

Methods inherited from class java.lang.Object

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

Field Detail

JAVA

public static final String JAVA

See Also:

Constant Field Values

CS

public static final String CS

See Also:

Constant Field Values

Constructor Detail

AvroConfigurationSerializer

@Inject
public AvroConfigurationSerializer()

Method Detail

toAvro

public AvroConfiguration toAvro(Configuration configuration)

toFile

public void toFile(Configuration conf,
          File file)
            throws IOException

Description copied from interface: ConfigurationSerializer

Stores the given Configuration in the given File.

Specified by:

toFile in interface ConfigurationSerializer

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

public void toTextFile(Configuration conf,
              File file)
                throws IOException

Description copied from interface: ConfigurationSerializer

Stores the given Configuration in the given Text File.

Specified by:

toTextFile in interface ConfigurationSerializer

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

public byte[] toByteArray(Configuration conf)
                   throws IOException

Description copied from interface: ConfigurationSerializer

Writes the Configuration to a byte[].

Specified by:

toByteArray in interface ConfigurationSerializer

Parameters:

conf - the Configuration to be converted

Returns:

the byte array

Throws:

IOException - if encoding fails to write

toString

public String toString(Configuration configuration)

Description copied from interface: ConfigurationSerializer

Writes the Configuration as a String.

Specified by:

toString in interface ConfigurationSerializer

Parameters:

configuration - the Configuration to be converted

Returns:

a String representation of the Configuration

fromAvro

public Configuration fromAvro(AvroConfiguration avroConfiguration)
                       throws BindException

Converts a given AvroConfiguration to Configuration.

Parameters:

avroConfiguration - a Avro configuration

Returns:

a Configuration version of the given AvroConfiguration

Throws:

BindException

fromAvro

public Configuration fromAvro(AvroConfiguration avroConfiguration,
                     ClassHierarchy classHierarchy)
                       throws BindException

Converts a given AvroConfiguration to Configuration.

Parameters:

avroConfiguration - a Avro configuration

classHierarchy - the class hierarchy used for validation.

Returns:

a Configuration version of the given AvroConfiguration

Throws:

BindException

fromFile

public Configuration fromFile(File file)
                       throws IOException,
                              BindException

Description copied from interface: ConfigurationSerializer

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

Specified by:

fromFile in interface ConfigurationSerializer

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

fromFile

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

Description copied from interface: ConfigurationSerializer

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

Specified by:

fromFile in interface ConfigurationSerializer

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

fromTextFile

public Configuration fromTextFile(File file)
                           throws IOException,
                                  BindException

Description copied from interface: ConfigurationSerializer

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

Specified by:

fromTextFile in interface ConfigurationSerializer

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

public Configuration fromTextFile(File file,
                         ClassHierarchy classHierarchy)
                           throws IOException,
                                  BindException

Description copied from interface: ConfigurationSerializer

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

Specified by:

fromTextFile in interface ConfigurationSerializer

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

BindException

fromByteArray

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

Description copied from interface: ConfigurationSerializer

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

Specified by:

fromByteArray in interface ConfigurationSerializer

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

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

Description copied from interface: ConfigurationSerializer

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

Specified by:

fromByteArray in interface ConfigurationSerializer

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

public Configuration fromString(String theString)
                         throws IOException,
                                BindException

Description copied from interface: ConfigurationSerializer

Decodes a String generated via toString().

Specified by:

fromString in interface ConfigurationSerializer

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

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

Description copied from interface: ConfigurationSerializer

Decodes a String generated via toString().

Specified by:

fromString in interface ConfigurationSerializer

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.

configurationBuilderFromString

public void configurationBuilderFromString(String theString,
                                  ConfigurationBuilder configBuilder)
                                    throws IOException,
                                           BindException

Converts a given serialized string to ConfigurationBuilder from which Configuration can be produced.

Parameters:

theString - the String containing configuration

configBuilder - a configuration builder

Throws:

IOException - if the string is not Avro format

BindException - if the content of configuration string is invalid to bind