org.ops4j.util.collections
Class PropertiesUtils

java.lang.Object
  org.ops4j.util.collections.PropertiesUtils

public final class PropertiesUtils
extends java.lang.Object

Utility class supporting operations related to property retrival.

Method Summary

static java.lang.String	getProperty(java.util.Properties props, java.lang.String key, java.lang.String def) Return the value of a property.
static java.lang.String[]	readListFile(java.net.URL listFile) Read a file and return the list of lines in an array of strings.
static java.util.Properties	readProperties(java.io.InputStream stream, java.util.Properties mappings, boolean closeStream) Read a set of properties from a property file provided as an Inputstream.
static java.util.Properties	readProps(java.net.URL propsUrl, java.util.Properties mappings) Read a set of properties from a property file specificed by a url.
static java.lang.String	resolveProperty(java.util.Properties props, java.lang.String value) Resolve symbols in a supplied value against supplied known properties.

Methods inherited from class java.lang.Object

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

Method Detail

readProps

public static java.util.Properties readProps(java.net.URL propsUrl,
                                             java.util.Properties mappings)
                                      throws java.io.IOException

Read a set of properties from a property file specificed by a url.

Parameters:

propsUrl - the url of the property file to read

mappings - Properties that will be available for translations initially.

Returns:

the resolved properties

Throws:

java.io.IOException - if an io error occurs

See Also:

readProperties(java.io.InputStream,java.util.Properties,boolean)

readProperties

public static java.util.Properties readProperties(java.io.InputStream stream,
                                                  java.util.Properties mappings,
                                                  boolean closeStream)
                                           throws java.io.IOException

Read a set of properties from a property file provided as an Inputstream.

Property files may reference symbolic properties in the form ${name}. Translations occur from both the mappings properties as well as all values within the Properties that are being read.

Example;

   Properties mappings = System.getProperties();
   Properties myProps = PropertiesUtils.readProperties( "mine.properties", mappings );
 

and the "mine.properties" file contains;

 mything=${myplace}/mything
 myplace=${user.home}/myplace
 

then the Properties object myProps will contain;

 mything=/home/niclas/myplace/mything
 myplace=/home/niclas/myplace
 

Parameters:

stream - the InputStream of the property file to read.

mappings - Properties that will be available for translations initially.

closeStream - true if the method should close the stream before returning, false otherwise.

Returns:

the resolved properties.

Throws:

java.io.IOException - if an io error occurs

resolveProperty

public static java.lang.String resolveProperty(java.util.Properties props,
                                               java.lang.String value)

Resolve symbols in a supplied value against supplied known properties.

Parameters:

props - a set of know properties

value - the string to parse for tokens

Returns:

the resolved string

getProperty

public static java.lang.String getProperty(java.util.Properties props,
                                           java.lang.String key,
                                           java.lang.String def)

Return the value of a property.

Parameters:

props - the property file

key - the property key to lookup

def - the default value

Returns:

the resolve value

readListFile

public static java.lang.String[] readListFile(java.net.URL listFile)
                                       throws java.io.IOException

Read a file and return the list of lines in an array of strings.

Parameters:

listFile - the url to read from

Returns:

the lines

Throws:

java.io.IOException - if a read error occurs