cn.sissors.hummingbird.runtime.config

Class PropertiesHandler

java.lang.Object

cn.sissors.hummingbird.runtime.config.PropertiesHandler

public class PropertiesHandler
extends Object

This is an assistance tool for handling .properties format file.

Also, you can use this handler individually, to create or update .properties format file.

Version:

2018-05-10

Author:

zyz

Constructor Summary

Constructors

Constructor and Description
PropertiesHandler()

Method Summary

Modifier and Type	Method and Description
static Properties	load(InputStreamReader inputStreamReader) Load .properties file and return a Properties object
static Properties	load(String path) Load .properties file and return a Properties object
static void	save(String path, Map<String,String> params) Save a java map to external in .properties format.
static void	save(String path, Properties properties) Save a Properties object to external file.
static Properties	update(Properties properties, Map<String,String> params) Update a Properties object with a java map.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesHandler

public PropertiesHandler()

Method Detail

load

public static Properties load(InputStreamReader inputStreamReader)
                       throws IOException

Load .properties file and return a Properties object

Parameters:

inputStreamReader - the input stream of external file

Returns:

a Properties object

Throws:

IOException - if an error occurred when reading from the input stream.

load

public static Properties load(String path)
                       throws IOException

Load .properties file and return a Properties object

Parameters:

path - the path of external file

Returns:

a Properties object

Throws:

IOException - file not exists or if an error occurred when reading from the input stream.

update

public static Properties update(Properties properties,
                                Map<String,String> params)

Update a Properties object with a java map.

Parameters:

properties - the properties

params - java map

Returns:

the properties after updating

save

public static void save(String path,
                        Properties properties)
                 throws IOException

Save a Properties object to external file.

Parameters:

path - external location

properties - a Properties object

Throws:

IOException - if writing this property list to the specified output stream throws an IOException.

save

public static void save(String path,
                        Map<String,String> params)
                 throws IOException

Save a java map to external in .properties format.

Parameters:

path - external location

params - java map

Throws:

IOException - if writing this property list to the specified output stream throws an IOException.