org.apache.fop.configuration
Class Configuration
- public class Configuration
a configuration class for all general configuration aspects except those
related to specific renderers. All configuration is stored
in key / value pairs. The value can be a String, a list of Strings
or a map, containing a list of key / value pairs.
Field Summary |
final static int | AWT |
final static int | PDF |
final static int | STANDARD defines role types |
Method Summary |
static void | dumpConfiguration() debug methods, which writes out all information in this configuration |
static Boolean | getBooleanValue(String key, int role) convenience methods to access boolean values in the configuration |
static Boolean | getBooleanValue(String key) convenience methods to access boolean values in the configuration |
static Hashtable | getConfiguration() |
static Hashtable | getHashtableValue(String key, int role) convenience methods to access map/hashtable values in the configuration |
static Hashtable | getHashtableValue(String key) convenience methods to access map/hashtable values in the standard configuration |
static int | getIntValue(String key, int role) convenience methods to access int values in the configuration |
static int | getIntValue(String key) convenience methods to access int values in the standard configuration |
static Vector | getListValue(String key, int role) convenience methods to access list values in the configuration |
static Vector | getListValue(String key) convenience methods to access list values in the standard configuration |
static String | getStringValue(String key, int role) convenience methods to access strings values in the configuration |
static String | getStringValue(String key) convenience methods to access strings values in the standard configuration |
static Object | getValue(String key, int role) general access method |
static Object | getValue(String key) convenience method which retrieves some configuration information
from the standard configuration |
static void | put(String key, Object value, int role) adds information to the configuration map/hashtable in key,value form |
static void | put(String key, Object value) adds information to the standard configuration map/hashtable in key,value form |
static void | setup(int role, Hashtable config) initializes this configuration |
AWT
public final static int AWT
PDF
public final static int PDF
STANDARD
public final static int STANDARD
- defines role types
dumpConfiguration
public static void dumpConfiguration()
- debug methods, which writes out all information in this configuration
getBooleanValue
public static Boolean getBooleanValue(String key, int role)
- convenience methods to access boolean values in the configuration
- Parameters:
- key - a string containing the key value for the configuration value
role detemines the configuration target
- Returns: boolean true or false as value
-1 if the key is not defined.
getBooleanValue
public static Boolean getBooleanValue(String key)
- convenience methods to access boolean values in the configuration
- Parameters:
- key - a string containing the key value for the configuration value
- Returns: boolean true or false as value
-1 if the key is not defined.
getConfiguration
public static Hashtable getConfiguration()
getHashtableValue
public static Hashtable getHashtableValue(String key, int role)
- convenience methods to access map/hashtable values in the configuration
- Parameters:
- key - a string containing the key value for the configuration value
role detemines the configuration target
- Returns: Hashtable a Hashtable containing the values
null if the key is not defined.
getHashtableValue
public static Hashtable getHashtableValue(String key)
- convenience methods to access map/hashtable values in the standard configuration
- Parameters:
- key - a string containing the key value for the configuration value
- Returns: Hashtable a Hashtable containing the values
null if the key is not defined.
getIntValue
public static int getIntValue(String key, int role)
- convenience methods to access int values in the configuration
- Parameters:
- key - a string containing the key value for the configuration value
role detemines the configuration target
- Returns: int a int containing the value
-1 if the key is not defined.
getIntValue
public static int getIntValue(String key)
- convenience methods to access int values in the standard configuration
- Parameters:
- key - a string containing the key value for the configuration value
- Returns: int a int containing the value
-1 if the key is not defined.
getListValue
public static Vector getListValue(String key, int role)
- convenience methods to access list values in the configuration
- Parameters:
- key - a string containing the key value for the configuration value
role detemines the configuration target
- Returns: Vector a Vector containing the values
null if the key is not defined.
getListValue
public static Vector getListValue(String key)
- convenience methods to access list values in the standard configuration
- Parameters:
- key - a string containing the key value for the configuration value
- Returns: Vector a Vector containing the values
null if the key is not defined.
getStringValue
public static String getStringValue(String key, int role)
- convenience methods to access strings values in the configuration
- Parameters:
- key - a string containing the key value for the configuration value
role detemines the configuration target
- Returns: String a string containing the value
null if the key is not defined.
getStringValue
public static String getStringValue(String key)
- convenience methods to access strings values in the standard configuration
- Parameters:
- key - a string containing the key value for the configuration value
- Returns: String a string containing the value
null if the key is not defined.
getValue
public static Object getValue(String key, int role)
- general access method
- Parameters:
- key - a string containing the key value for the configuration value
role detemines the configuration target
- Returns: Object containing the value; normally you would use one of the
convenience methods, which return the correct form.
null if the key is not defined.
getValue
public static Object getValue(String key)
- convenience method which retrieves some configuration information
from the standard configuration
- Parameters:
- key - a string containing the key value for the configuration value
- Returns: Object containing the value; normally you would use one of the
convenience methods, which return the correct form.
null if the key is not defined.
put
public static void put(String key, Object value, int role)
- adds information to the configuration map/hashtable in key,value form
- Parameters:
- key - a string containing the key value for the configuration value
value the configuration information
role detemines the configuration target
- value - an Object containing the value; can be a String, a Vector or a Hashtable
put
public static void put(String key, Object value)
- adds information to the standard configuration map/hashtable in key,value form
- Parameters:
- key - a string containing the key value for the configuration value
value the configuration information
role detemines the configuration target
- value - an Object containing the value; can be a String, a Vector or a Hashtable
setup
public static void setup(int role, Hashtable config)
- initializes this configuration
- Parameters:
- config - contains the configuration information
to Class java.util.Hashtable- stores the configuration information
to Class java.util.Hashtable
to Class java.util.Hashtable
to Class java.util.Hashtable
- contains a Hashtable of existing Hashtables