writer2latex.api
Interface Config

All Known Implementing Classes:
ConfigBase, LaTeXConfig, XhtmlConfig

public interface Config

This is an interface for configuration of a Converter. A configuration always supports simple name/value options. In addition, you can read and write configurations using streams or abstract file names. The format depends on the Converter implementation, cf. the user's manual.


Method Summary
 ComplexOption getComplexOption(java.lang.String sName)
          Get a complex option
 java.lang.String getOption(java.lang.String sName)
          Get a named option
 void read(java.io.File file)
          Read a configuration (file based version)
 void read(java.io.InputStream is)
          Read a configuration (stream based version)
 void readDefaultConfig(java.lang.String sName)
          Read a default configuration: The available configurations depend on the Converter implementation
 void setOption(java.lang.String sName, java.lang.String sValue)
          Set a name/value option.
 void write(java.io.File file)
          Write the configuration (file based version)
 void write(java.io.OutputStream os)
          Write the configuration (stream based version)
 

Method Detail

readDefaultConfig

void readDefaultConfig(java.lang.String sName)
                       throws java.lang.IllegalArgumentException
Read a default configuration: The available configurations depend on the Converter implementation

Parameters:
sName - the name of the configuration
Throws:
java.lang.IllegalArgumentException - if the configuration does not exist

read

void read(java.io.InputStream is)
          throws java.io.IOException
Read a configuration (stream based version)

Parameters:
is - the InputStream to read from
Throws:
java.io.IOException - if an error occurs reading the stream, or the data is not in the right format

read

void read(java.io.File file)
          throws java.io.IOException
Read a configuration (file based version)

Parameters:
file - the File to read from
Throws:
java.io.IOException - if the file does not exist, an error occurs reading the file, or the data is not in the right format

write

void write(java.io.OutputStream os)
           throws java.io.IOException
Write the configuration (stream based version)

Parameters:
os - the OutputStream to write to
Throws:
java.io.IOException - if an error occurs writing to the stream

write

void write(java.io.File file)
           throws java.io.IOException
Write the configuration (file based version)

Parameters:
file - the File to write to
Throws:
java.io.IOException - if an error occurs writing to the file

setOption

void setOption(java.lang.String sName,
               java.lang.String sValue)
Set a name/value option. Options that are not defined by the Converter implementation as well as null values are silently ignored

Parameters:
sName - the name of the option
sValue - the value of the option

getOption

java.lang.String getOption(java.lang.String sName)
Get a named option

Parameters:
sName - the name of the option
Returns:
the value of the option, or null if the option does not exist or the given name is null

getComplexOption

ComplexOption getComplexOption(java.lang.String sName)
Get a complex option

Parameters:
sName - the name of the complex option
Returns:
the option