dk.heick.properties.io

Class FilePropertyIOFactory

java.lang.Object

dk.heick.properties.io.FilePropertyIOFactory

public class FilePropertyIOFactory
extends Object

Factory class for construction of FilePropertyIO.
NOTE: This class is not stable yet.

Author:

Frederik Heick

Constructor Summary

Constructors

Constructor and Description
FilePropertyIOFactory()

Method Summary

Modifier and Type	Method and Description
static FilePropertyIO	createFilePropertyIO(File rootDirectory, String propertyFilename, boolean readonly, boolean cached) Searches for the propertyFilename in directory or sub directory of rootDirectory, and returns a FilePropertyIO.
static File	findPropertyFile(File rootDirectory, String propertyFilename) Searching for a file with name propertyFilename in the root directory or in one of its sub directories.
static File[]	findPropertyFiles(File rootDirectory) Find all the properties files in the root directory or in one of its sub directories.
static File[]	findPropertyFiles(File rootDirectory, String filename) Find all the properties files with a certain name in the root directory or in one of its sub directories.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePropertyIOFactory

public FilePropertyIOFactory()

Method Detail

createFilePropertyIO

public static FilePropertyIO createFilePropertyIO(File rootDirectory,
                                                  String propertyFilename,
                                                  boolean readonly,
                                                  boolean cached)
                                           throws PropertyIOException

Searches for the propertyFilename in directory or sub directory of rootDirectory, and returns a FilePropertyIO.

Parameters:

rootDirectory - the directory to start the search.

propertyFilename - the property filename to search for.

readonly - if the FilePropertyIO be read only.

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

Returns:

a FilePropertyIO with the first file found in the root or sub directory thereof, with the property filename.

Throws:

PropertyIOException - if a file with filename propertyFilename is not found.

findPropertyFile

public static File findPropertyFile(File rootDirectory,
                                    String propertyFilename)

Searching for a file with name propertyFilename in the root directory or in one of its sub directories.

Parameters:

rootDirectory - the root directory to start the search in.

propertyFilename - the filename to search for, not case sensitive. Not a filter name, but the complete filename.

Returns:

the first File found with that name, otherwise null is returned.

findPropertyFiles

public static File[] findPropertyFiles(File rootDirectory)

Find all the properties files in the root directory or in one of its sub directories.

Parameters:

rootDirectory - the directory to start the search in.

Returns:

an array of files which ends with "*.properties". If none found an empty array is returned.

findPropertyFiles

public static File[] findPropertyFiles(File rootDirectory,
                                       String filename)

Find all the properties files with a certain name in the root directory or in one of its sub directories.

Parameters:

rootDirectory - the directory to start the search in.

filename - the name of the file you are searching for, can be a filter.

Returns:

an array of files which ends with your filename. If none found an empty array is returned.

See Also:

WildCardFilenameFilter