Package org.jbake.app.configuration

Class ConfigUtil

java.lang.Object

org.jbake.app.configuration.ConfigUtil

public class ConfigUtil
extends java.lang.Object

Provides Configuration related functions.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIG_FILE
static java.lang.String	DEFAULT_CONFIG_FILE
static java.lang.String	DEFAULT_ENCODING
static java.lang.String	LEGACY_CONFIG_FILE
static char	LIST_DELIMITER

Constructor Summary

Constructors

Constructor	Description
ConfigUtil()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getEncoding()
JBakeConfiguration	loadConfig(java.io.File source)	Deprecated. use loadConfig(File, File) instead
JBakeConfiguration	loadConfig(java.io.File source, java.io.File propertiesFile)	Load a configuration.
ConfigUtil	setEncoding(java.lang.String encoding)

Methods inherited from class java.lang.Object

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

Field Detail

LIST_DELIMITER

public static final char LIST_DELIMITER

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

See Also:

Constant Field Values

LEGACY_CONFIG_FILE

public static final java.lang.String LEGACY_CONFIG_FILE

See Also:

Constant Field Values

CONFIG_FILE

public static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

DEFAULT_CONFIG_FILE

public static final java.lang.String DEFAULT_CONFIG_FILE

See Also:

Constant Field Values

Constructor Detail

ConfigUtil

public ConfigUtil()

Method Detail

loadConfig

public JBakeConfiguration loadConfig(java.io.File source,
                                     java.io.File propertiesFile)
                              throws JBakeException

Load a configuration.

Parameters:

source - the source directory of the project

propertiesFile - the properties file for the project

Returns:

the configuration

Throws:

JBakeException - if unable to configure

loadConfig

@Deprecated
public JBakeConfiguration loadConfig(java.io.File source)
                              throws org.apache.commons.configuration2.ex.ConfigurationException

Deprecated.

use loadConfig(File, File) instead

Load a configuration.

Parameters:

source - the source directory of the project

Returns:

the configuration

Throws:

org.apache.commons.configuration2.ex.ConfigurationException - if unable to configure

getEncoding

public java.lang.String getEncoding()

setEncoding

public ConfigUtil setEncoding(java.lang.String encoding)