com.neovisionaries.android.util

Class PropertiesLoader

java.lang.Object

com.neovisionaries.android.util.PropertiesLoader

public class PropertiesLoader
extends Object

Properties loader.

Since:

1.8

Author:

Takahiko Kawasaki

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertiesLoader.FileLocation File location types.

Constructor Summary

Constructors

Constructor and Description
PropertiesLoader()

Method Summary

Modifier and Type	Method and Description
static TypedProperties	load(String file) Load properties from a file.
static TypedProperties	load(String file, PropertiesLoader.FileLocation location) Load properties from a file.
static TypedProperties	load(String file, PropertiesLoader.FileLocation[] locations) Load properties from a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesLoader

public PropertiesLoader()

Method Detail

load

public static TypedProperties load(String file)

Load properties from a file.

This method is an alias of load(file, FileLocation.values()).

Parameters:

file - File name.

Returns:

Properties loaded from the file. null is returned on failure.

Throws:

IllegalArgumentException - file is null.

load

public static TypedProperties load(String file,
                                   PropertiesLoader.FileLocation[] locations)

Load properties from a file.

This method tries to load the file from the given locations in the order by calling load(String, FileLocation). The content of the first successfully-loaded file is returned.

Parameters:

file - File name.

locations - Locations from which the file is loaded.

Returns:

Properties loaded from the file. null is returned on failure.

Throws:

IllegalArgumentException - file is null, or locations is null.

load

public static TypedProperties load(String file,
                                   PropertiesLoader.FileLocation location)

Load properties from a file.

Parameters:

file - File name. If location is CLASSPATH and if file does not start with "/", "/" is prepended.

location - Location from which the file is loaded.

Returns:

Properties loaded from the file. null is returned on failure.

Throws:

IllegalArgumentException - file is null, or location is null.