org.foray.app
Class Options

java.lang.Object
  org.foray.app.Options

public class Options
extends Object

Loads configuration files and additional setting of commandline options.

Constructor Summary

Options(SessionConfig sessionConfig, OutputConfig renderConfig)
Constructor for case when the user configuration file is not known.

Options(SessionConfig sessionConfig, OutputConfig renderConfig, URL userConfigFile)
Constructor for case when the user configuration file is known.

Method Summary

SessionConfig	getSessionConfig() Returns the session configuration.
void	loadUserconfiguration(InputSource userConfigSource) Loades a user configuration from an InputSource.
void	loadUserconfiguration(URL userConfigFile) Loads a user configuration from a URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options(SessionConfig sessionConfig,
               OutputConfig renderConfig)

Constructor for case when the user configuration file is not known.

Parameters:

sessionConfig - The session configuration.

renderConfig - The output configuration.

Options

public Options(SessionConfig sessionConfig,
               OutputConfig renderConfig,
               URL userConfigFile)
        throws FOrayException

Constructor for case when the user configuration file is known.

Parameters:

sessionConfig - The session configuration.

renderConfig - The output configuration.

userConfigFile - The user configuration to be processed.

Throws:

FOrayException - For errors during construction.

Method Detail

loadUserconfiguration

public void loadUserconfiguration(URL userConfigFile)
                           throws FOrayException

Loads a user configuration from a URL.

Parameters:

userConfigFile - The URL to be loaded.

Throws:

FOrayException - If the URL cannot be accessed, or if there are errors loading it.

loadUserconfiguration

public void loadUserconfiguration(InputSource userConfigSource)
                           throws FOrayException

Loades a user configuration from an InputSource.

Parameters:

userConfigSource - The input source to be processed.

Throws:

FOrayException - For errors processing the configuration.

getSessionConfig

public SessionConfig getSessionConfig()

Returns the session configuration.

Returns:

The session configuration.