dk.heick.properties.io

Class CompositePropertyIOFactory

java.lang.Object

dk.heick.properties.io.CompositePropertyIOFactory

public class CompositePropertyIOFactory
extends Object

A factory class with to construct CompositePropertyIO.

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
CompositePropertyIOFactory()

Method Summary

Modifier and Type	Method and Description
static CompositePropertyIO	create(File[] files, boolean readonly, boolean cached, boolean mustExists) Constructs a CompositePropertyIO from a series of filenames.
static CompositePropertyIO	create(File rootDirectory, boolean readonly, boolean cached) Searches for all the properties files in directory or sub directory of rootDirectory, and returns a CompositePropertyIO with a list of FilePropertyIO.
static CompositePropertyIO	create(File rootDirectory, String[] propertyFilenames, boolean readonly, boolean cached) Searches for the propertyFilenames in directory or sub directory of rootDirectory, and returns a CompositePropertyIO with a list of FilePropertyIO.
static CompositePropertyIO	create(String[] fileNames, boolean readonly, boolean cached, boolean mustExists) Constructs a CompositePropertyIO from a series of filenames.
static org.apache.commons.logging.Log	getLogger()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositePropertyIOFactory

public CompositePropertyIOFactory()

Method Detail

create

public static CompositePropertyIO create(String[] fileNames,
                                         boolean readonly,
                                         boolean cached,
                                         boolean mustExists)
                                  throws PropertyIOException

Constructs a CompositePropertyIO from a series of filenames.
This will use the FilePropertyIO. This can fx. be used with String[] args from the java main method.

Parameters:

fileNames - an array of filenames.

readonly - is the CompositePropertyIO be read only.

cached - is the values be cached in the PropertyIO's.

mustExists - if true than all the files must exists File.exists otherwise a PropertyException.

Returns:

a CompositePropertyIO with FilePropertyIO's.

Throws:

PropertyIOException - if any of the files do not exists and mustExists is true

create

public static CompositePropertyIO create(File[] files,
                                         boolean readonly,
                                         boolean cached,
                                         boolean mustExists)
                                  throws PropertyIOException

Constructs a CompositePropertyIO from a series of filenames.
This will use the FilePropertyIO.

Parameters:

files - an array of File's.

readonly - shall the CompositePropertyIO be read only.

cached - shall the values be cached in the FilePropertyIO's.

mustExists - if true than all the files must exists File.exists otherwise a PropertyException.

Returns:

a CompositePropertyIO with FilePropertyIO's.

Throws:

PropertyIOException - if any of the files do not exists and mustExists is true

create

public static CompositePropertyIO create(File rootDirectory,
                                         String[] propertyFilenames,
                                         boolean readonly,
                                         boolean cached)
                                  throws PropertyIOException

Searches for the propertyFilenames in directory or sub directory of rootDirectory, and returns a CompositePropertyIO with a list of FilePropertyIO.

Parameters:

rootDirectory - the directory to start the search.

propertyFilenames - the property filenames to search for.

readonly - if the FilePropertyIO be read only.

cached - shall the values be cached in the PropertyIO's.

Returns:

an instance of CompositePropertyIO with a list of FilePropertyIO loading properties from files found by their name.

Throws:

PropertyIOException - if one of the property filenames is not found in root directory or one of its sub directories.

create

public static CompositePropertyIO create(File rootDirectory,
                                         boolean readonly,
                                         boolean cached)
                                  throws PropertyIOException

Searches for all the properties files in directory or sub directory of rootDirectory, and returns a CompositePropertyIO with a list of FilePropertyIO.

Parameters:

rootDirectory - the directory to start the search.

readonly - if the FilePropertyIO be read only.

cached - shall the values be cached in the PropertyIO's.

Returns:

an instance of CompositePropertyIO with a list of FilePropertyIO loading properties from files found by their name.

Throws:

PropertyIOException - construction of CompositePropertyIO.

getLogger

public static final org.apache.commons.logging.Log getLogger()