org.robokind.api.common.services

Interface ConfigurationWriter<ServiceConfig,Param>

public interface ConfigurationWriter<ServiceConfig,Param>

Author:

Matthew Stevenson

Method Summary

Methods

Modifier and Type	Method and Description
Class<ServiceConfig>	getConfigurationClass() Returns the Class of the ServiceConfig to write.
VersionProperty	getConfigurationFormat() Specifies the Service Configuration Format version to write.
Class<Param>	getParameterClass() Returns the Class of the Parameter required to write a ServiceConfig.
boolean	writeConfiguration(ServiceConfig config, Param param) Writes a ServiceConfig of the specified type using the given parameters.

Method Detail

getConfigurationFormat

VersionProperty getConfigurationFormat()

Specifies the Service Configuration Format version to write.

Returns:

VersionProperty specifying the Service Configuration Format to write

writeConfiguration

boolean writeConfiguration(ServiceConfig config,
                         Param param)
                           throws Exception

Writes a ServiceConfig of the specified type using the given parameters.

Parameters:

config - ServiceConfig to write

param - parameters needed to write the ServiceConfig, such as a File

Throws:

Exception - if there is an error writing the configuration

getConfigurationClass

Class<ServiceConfig> getConfigurationClass()

Returns the Class of the ServiceConfig to write.

Returns:

Class of the ServiceConfig to write

getParameterClass

Class<Param> getParameterClass()

Returns the Class of the Parameter required to write a ServiceConfig.

Returns:

Class of the Parameter required to write a ServiceConfig