Package org.apache.commons.collections4.properties

Class AbstractPropertiesFactory<T extends Properties>

java.lang.Object

org.apache.commons.collections4.properties.AbstractPropertiesFactory<T>

Type Parameters:

T - Properties or a subclass like SortedProperties.

Direct Known Subclasses:

PropertiesFactory, SortedPropertiesFactory

public abstract class AbstractPropertiesFactory<T extends Properties>
extends Object

Subclasses create and load Properties and subclasses of Properties like SortedProperties.

Since:

4.4

See Also:

Properties

Method Summary

Modifier and Type	Method	Description
T	load(File file)	Creates and loads properties from the given file.
T	load(InputStream inputStream)	Creates and loads properties from the given input stream.
T	load(Reader reader)	Creates and loads properties from the given reader.
T	load(ClassLoader classLoader, String name)	Creates and loads properties from the given file.
T	load(String name)	Creates and loads properties from the given file name.
T	load(URI uri)	Creates and loads properties from the given URI.
T	load(URL url)	Creates and loads properties from the given URL.
T	load(Path path)	Creates and loads properties from the given path.

Methods inherited from class java.lang.Object

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

Method Detail

load

public T load(ClassLoader classLoader,
              String name)
       throws IOException

Creates and loads properties from the given file.

Parameters:

classLoader - the class loader to use to get the named resource.

name - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

load

public T load(File file)
       throws FileNotFoundException,
              IOException

Creates and loads properties from the given file.

Parameters:

file - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

FileNotFoundException - Thrown if the file does not exist, is a directory, or cannot be opened for reading.

SecurityException - Thrown if a security manager's checkRead method denies read access to the file.

load

public T load(InputStream inputStream)
       throws IOException

Creates and loads properties from the given input stream.

Parameters:

inputStream - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

load

public T load(Path path)
       throws IOException

Creates and loads properties from the given path.

Parameters:

path - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

load

public T load(Reader reader)
       throws IOException

Creates and loads properties from the given reader.

Parameters:

reader - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

load

public T load(String name)
       throws IOException

Creates and loads properties from the given file name.

Parameters:

name - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

load

public T load(URI uri)
       throws IOException

Creates and loads properties from the given URI.

Parameters:

uri - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.

load

public T load(URL url)
       throws IOException

Creates and loads properties from the given URL.

Parameters:

url - the location of the properties file.

Returns:

a new properties object.

Throws:

IOException - Thrown if an error occurred reading the input stream.

IllegalArgumentException - Thrown if the input contains a malformed Unicode escape sequence.