com.mkdoc.util
Interface ApplicationContext

All Known Implementing Classes:
AbstractApplicationContext, FileApplicationContext, PluginApplicationContext, ServletApplicationContext

public interface ApplicationContext

An application context that contains configuration parameters.

Version:
0.5 2005-12-09
Author:
Philip Shaw

Field Summary
static java.lang.String ABSOLUTE
          The absolute file path property name.
static java.lang.String DIRECTORY
          The output file path property name.
static java.lang.String REPOSITORY
          A repository file path associated with the application.
 
Method Summary
 boolean getBooleanParameter(java.lang.String name)
          Get a named parameter value.
 java.lang.Class getClassParameter(java.lang.String name)
          Get a named parameter value.
 java.io.File getStoreDirectory()
          Get a (temporary) output folder associated with the application.
 java.lang.String getStorePath()
          Get the reopsitory file path, if any.
 java.lang.String getStringParameter(java.lang.String name)
          Get a named parameter value.
 void setParameter(java.lang.String name, java.lang.String value)
          Set a parameter value.
 

Field Detail

ABSOLUTE

public static final java.lang.String ABSOLUTE
The absolute file path property name.

Since:
Version 0.1 2005-10-04
See Also:
Constant Field Values

DIRECTORY

public static final java.lang.String DIRECTORY
The output file path property name.

Since:
Version 0.1 2005-10-04
See Also:
Constant Field Values

REPOSITORY

public static final java.lang.String REPOSITORY
A repository file path associated with the application.

Since:
Version 0.3 2005-10-04
See Also:
Constant Field Values
Method Detail

getStringParameter

public java.lang.String getStringParameter(java.lang.String name)
Get a named parameter value.

Parameters:
name - The name of the parameter to look up.
Returns:
The value of the named parameter, or null if not found.
Since:
Version 0.1 2005-07-12

getClassParameter

public java.lang.Class getClassParameter(java.lang.String name)
Get a named parameter value.

Parameters:
name - The name of the parameter to look up.
Returns:
A reference to the class of the named parameter, or null if there is a problem loading the class.
Since:
Version 0.1 2005-07-12

getBooleanParameter

public boolean getBooleanParameter(java.lang.String name)
Get a named parameter value.

Parameters:
name - The name of the parameter to look up.
Returns:
The boolean value of named parameter, or false if not found.
Since:
Version 0.1 2005-07-12

getStoreDirectory

public java.io.File getStoreDirectory()
Get a (temporary) output folder associated with the application.

Returns:
A File reference for the named parameter, or null if not found.
Since:
Version 0.1 2005-07-12

getStorePath

public java.lang.String getStorePath()
Get the reopsitory file path, if any.

Returns:
An absolute file path, or null if not found.
Since:
Version 0.3 2005-10-04

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
Set a parameter value.

Parameters:
name - The parameter name.
value - The parameter value.
Since:
Version 0.5 2005-12-09