org.apache.maven.doxia.module.fo
Class FoConfiguration

java.lang.Object
  org.apache.maven.doxia.module.fo.FoConfiguration

public class FoConfiguration
extends Object

A utility class to construct FO configuration parameters.

Since:

1.1

Version:

$Id: FoConfiguration.java 1091053 2011-04-11 12:55:07Z ltheussl $

Author:

ltheussl

Constructor Summary

FoConfiguration()
Constructor.

Method Summary

MutableAttributeSet	getAttributeSet(String attributeId) Builds a set of attributes.
String	getAttributeString(String attributeId) Builds a list of attributes.
void	load(File configFile) Load configuration parameters from a File.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoConfiguration

public FoConfiguration()

Constructor.

Method Detail

load

public void load(File configFile)
          throws IOException

Load configuration parameters from a File.

Parameters:

configFile - the configuration file.

Throws:

IOException - if the File cannot be read or some error occurs when initializing the configuration parameters.

Since:

1.1.1

getAttributeString

public String getAttributeString(String attributeId)

Builds a list of attributes.

Parameters:

attributeId - A unique id to identify the set of attributes. This should correspond to the name of an attribute-set defined in the configuration file.

Returns:

A string that contains a list of attributes with the values configured for the current builder. Returns the empty string if attributeId is null or if attributeId is not a valid identifier.

getAttributeSet

public MutableAttributeSet getAttributeSet(String attributeId)

Builds a set of attributes.

Parameters:

attributeId - A unique id to identify the set of attributes. This should correspond to the name of an attribute-set defined in the configuration file.

Returns:

A MutableAttributeSet that contains the attributes with the values configured for the current builder. Returns null if attributeId is null or empty, or if attributeId is not a valid identifier.