Module datarush.commons

Package com.pervasive.datarush.commons.util

Class PropertiesFileUtil

java.lang.Object

com.pervasive.datarush.commons.util.PropertiesFileUtil

public class PropertiesFileUtil
extends Object

Utility methods to consume properties files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PropertiesFileUtil.PropertyFileType

Constructor Summary

Constructors

Constructor	Description
PropertiesFileUtil()

Method Summary

Modifier and Type	Method	Description
static Properties	loadFromJSON(InputStream in)	Loads a JSON formatted string from a stream into a Properties object.
static Properties	loadFromJSON(String filePath)	Loads a JSON file from disk into a Properties object.
static Properties	loadFromXML(InputStream in)	Loads a XML string from a stream into a Properties object.
static Properties	loadFromXML(String filePath)	Loads a XML file from disk into a Properties object.
static Properties	read(File propertiesFile)	Loads a .properties-formatted file from disk into a Properties object.
static Properties	read(InputStream in)	Loads a .properties-formatted string from a stream into a Properties object.
static Properties	read(String propertiesPath)	Loads a .properties-formatted file from disk into a Properties object.
static void	write(File propertiesFile, Properties data, String comment)	Writes a Properties object to disk.
static void	write(String propertiesPath, Properties data, String comment)	Writes a Properties object to disk.

Methods inherited from class java.lang.Object

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

Constructor Details

PropertiesFileUtil

public PropertiesFileUtil()

Method Details

read

public static Properties read(String propertiesPath)

Loads a .properties-formatted file from disk into a Properties object. On error, the input stream is properly closed and a user-friendly exception is thrown.

Parameters:

propertiesPath - the path to the file to load

Returns:

a Properties object populated with the specified file's data

read

public static Properties read(File propertiesFile)

Loads a .properties-formatted file from disk into a Properties object. On error, the input stream is properly closed and a user-friendly exception is thrown.

Parameters:

propertiesFile - the file to load

Returns:

a Properties object populated with the specified file's data

read

public static Properties read(InputStream in)
                       throws IOException

Loads a .properties-formatted string from a stream into a Properties object. However this method will not close the stream or handle exceptions directly.

Parameters:

in - inputstream containing properties

Returns:

a Properties object populated with the specified file's data

Throws:

IOException

write

public static void write(String propertiesPath,
 Properties data,
 String comment)

Writes a Properties object to disk. On error, the output stream is properly closed and a user-friendly exception is thrown.

Parameters:

propertiesPath - the path to the file to write

data - the Properties object to store

comment - an optional comment to include at the top of the written file

write

public static void write(File propertiesFile,
 Properties data,
 String comment)

Writes a Properties object to disk. On error, the output stream is properly closed and a user-friendly exception is thrown.

Parameters:

propertiesFile - the file to write

data - the Properties object to store

comment - an optional comment to include at the top of the written file

loadFromJSON

public static Properties loadFromJSON(String filePath)

Loads a JSON file from disk into a Properties object. On error, the input stream is properly closed and a user-friendly exception is thrown.

Parameters:

filePath - the path to the file to load

Returns:

a Properties object populated with the specified file's data

loadFromJSON

public static Properties loadFromJSON(InputStream in)
                               throws IOException

Loads a JSON formatted string from a stream into a Properties object. However this method will not close the stream or handle exceptions directly.

Parameters:

in - inputstream containing properties in JSON format

Returns:

a Properties object populated with the specified file's data

Throws:

IOException

loadFromXML

public static Properties loadFromXML(String filePath)

Loads a XML file from disk into a Properties object. On error, the input stream is properly closed and a user-friendly exception is thrown.

Parameters:

filePath - the path to the file to load

Returns:

a Properties object populated with the specified file's data

loadFromXML

public static Properties loadFromXML(InputStream in)
                              throws IOException

Loads a XML string from a stream into a Properties object. However this method will not close the stream or handle exceptions directly.

Parameters:

in - inputstream containing properties in XML format

Returns:

a Properties object populated with the specified file's data

Throws:

IOException