de.alpharogroup.collections.properties

Class PropertiesExtensions

java.lang.Object

de.alpharogroup.collections.properties.PropertiesExtensions

public final class PropertiesExtensions
extends Object

The Class PropertiesExtensions provides methods loading properties and other related operations for properties like find redundant values or getting all available languages from a bundle.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	PROPERTIES_DELIMITERS The Constant PROPERTIES_DELIMITERS contains all valid delimiters for properties files.
static String	SEARCH_FILE_PATTERN The Constant SEARCH_FILE_PATTERN is a regex for searching java and html files.

Constructor Summary

Constructors

Constructor and Description
PropertiesExtensions()

Method Summary

Modifier and Type	Method and Description
static void	export(Properties properties, OutputStream outputStream) Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file.
static void	export(Properties properties, OutputStream outputStream, InputStream inputStream, String comment, boolean loadFromXML, boolean storeToXML) Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file.
static void	export(Properties properties, OutputStream outputStream, String comment) Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file.
static Map<String,List<String>>	findRedundantValues(Properties properties) Finds redundant values from the given Properties object and saves it to a Map.
static Optional<Integer>	getInteger(Properties properties, String propertiesKey) Try to get a number from the given properties key from the given properties.
static Map<String,List<String>>	getMatchedPrefixLists(Properties properties) Finds all keys with the same key prefixes from the given Properties and saves them to a Map with the prefix as a key and holds a List with the whole keys the starts with the same key prefix.
static List<String>	getPropertyParameters(String propertyValue) Finds the property parameters from the given propertyValue.
static Properties	loadProperties(File propertiesFile) Load a Properties-object from the given File-object.
static Properties	loadProperties(File propertiesFile, boolean loadFromXML) Load a Properties-object from the given File-object.
static List<KeyValuePair<String,String>>	toKeyValuePairs(Properties properties) Transforms the given Properties to a list of KeyValuePair's.
static void	toProperties(File properties, File xml, String comment) Converts the given xml file to the given properties file.
static void	toProperties(OutputStream properties, InputStream xml, String comment) Converts the given xml InputStream to the given properties OutputStream.
static void	toProperties(OutputStream outputStream, InputStream inputStream, String comment, boolean xmlFile) Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file.
static void	toPropertiesFile(OutputStream outputStream, InputStream inputStream, String comment) Converts the given properties InputStream to the given properties OutputStream that represents the output file.
static void	toXml(File properties, File xml, String comment, String encoding) Converts the given properties file to the given xml file.
static void	toXml(InputStream properties, OutputStream xml, String comment, String encoding) Converts the given properties InputStream to the given xml OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_FILE_PATTERN

public static final String SEARCH_FILE_PATTERN

The Constant SEARCH_FILE_PATTERN is a regex for searching java and html files.

See Also:

Constant Field Values

PROPERTIES_DELIMITERS

public static final String[] PROPERTIES_DELIMITERS

The Constant PROPERTIES_DELIMITERS contains all valid delimiters for properties files.

Constructor Detail

PropertiesExtensions

public PropertiesExtensions()

Method Detail

findRedundantValues

public static Map<String,List<String>> findRedundantValues(Properties properties)

Finds redundant values from the given Properties object and saves it to a Map.

Parameters:

properties - The Properties to check.

Returns:

A map that contains the redundant value as the key of the map and a List(as value of the map) of keys that have the redundant value.

getMatchedPrefixLists

public static Map<String,List<String>> getMatchedPrefixLists(Properties properties)

Finds all keys with the same key prefixes from the given Properties and saves them to a Map with the prefix as a key and holds a List with the whole keys the starts with the same key prefix.

Parameters:

properties - the en properties

Returns:

the matched prefix lists

getPropertyParameters

public static List<String> getPropertyParameters(String propertyValue)

Finds the property parameters from the given propertyValue.

Parameters:

propertyValue - the property value

Returns:

the property parameters as a list.

loadProperties

public static Properties loadProperties(File propertiesFile)
                                 throws IOException

Load a Properties-object from the given File-object.

Parameters:

propertiesFile - the properties file

Returns:

the properties or null if the file is not found.

Throws:

IOException - Signals that an I/O exception has occurred.

loadProperties

public static Properties loadProperties(File propertiesFile,
                                        boolean loadFromXML)
                                 throws IOException

Load a Properties-object from the given File-object.

Parameters:

propertiesFile - the properties file

loadFromXML - the load from XML

Returns:

the properties or null if the file is not found.

Throws:

IOException - Signals that an I/O exception has occurred.

toKeyValuePairs

public static List<KeyValuePair<String,String>> toKeyValuePairs(Properties properties)

Transforms the given Properties to a list of KeyValuePair's.

Parameters:

properties - the properties

Returns:

the new list with the KeyValuePair's.

toProperties

public static void toProperties(File properties,
                                File xml,
                                String comment)
                         throws IOException

Converts the given xml file to the given properties file.

Parameters:

properties - the properties file. The xml file does not have to exist.

xml - the xml file with the properties to convert.

comment - the comment

Throws:

IOException - Signals that an I/O exception has occurred.

toProperties

public static void toProperties(OutputStream properties,
                                InputStream xml,
                                String comment)
                         throws IOException

Converts the given xml InputStream to the given properties OutputStream.

Parameters:

properties - the properties file. The xml file does not have to exist.

xml - the xml file with the properties to convert.

comment - the comment

Throws:

IOException - Signals that an I/O exception has occurred.

toPropertiesFile

public static void toPropertiesFile(OutputStream outputStream,
                                    InputStream inputStream,
                                    String comment)
                             throws IOException

Converts the given properties InputStream to the given properties OutputStream that represents the output file.

Parameters:

outputStream - the properties file. The xml file does not have to exist.

inputStream - the xml file with the properties to convert.

comment - the comment

Throws:

IOException - Signals that an I/O exception has occurred.

toProperties

public static void toProperties(OutputStream outputStream,
                                InputStream inputStream,
                                String comment,
                                boolean xmlFile)
                         throws IOException

Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file. The flag xmlFile tells if the output shell be an xml file or a properties file.

Parameters:

outputStream - the stream from the output properties file. If the file does not exists a new file will be created.

inputStream - the stream from input file with the properties to convert

comment - the comment

xmlFile - the flag that tells if the output shell be an xml file if true otherwise it will be an properties file

Throws:

IOException - Signals that an I/O exception has occurred.

export

public static void export(Properties properties,
                          OutputStream outputStream,
                          InputStream inputStream,
                          String comment,
                          boolean loadFromXML,
                          boolean storeToXML)
                   throws IOException

Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file. The flag xmlFile tells if the output shell be an xml file or a properties file.

Parameters:

properties - the properties to store

outputStream - the stream from the output properties file. If the file does not exists a new file will be created.

inputStream - the input stream

comment - the comment

loadFromXML - the flag that tells if the input shell be loaded from a XML file if true otherwise it will be loaded from a properties file

storeToXML - the flag that tells if the output shell be stored to a XML file if true otherwise it will be stored to a properties file

Throws:

IOException - Signals that an I/O exception has occurred.

export

public static void export(Properties properties,
                          OutputStream outputStream)
                   throws IOException

Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file. The flag xmlFile tells if the output shell be an xml file or a properties file.

Parameters:

properties - the properties to store

outputStream - the stream from the output properties file. If the file does not exists a new file will be created.

Throws:

IOException - Signals that an I/O exception has occurred.

export

public static void export(Properties properties,
                          OutputStream outputStream,
                          String comment)
                   throws IOException

Exports the given InputStream that represents a properties file to the given properties OutputStream that represents the output file. The flag xmlFile tells if the output shell be an xml file or a properties file.

Parameters:

properties - the properties to store

outputStream - the stream from the output properties file. If the file does not exists a new file will be created.

comment - the comment

Throws:

IOException - Signals that an I/O exception has occurred.

toXml

public static void toXml(File properties,
                         File xml,
                         String comment,
                         String encoding)
                  throws IOException

Converts the given properties file to the given xml file.

Parameters:

properties - the properties file.

xml - the xml file to write in. The xml file does not have to exist.

comment - the comment

encoding - the encoding for the xml file.

Throws:

IOException - Signals that an I/O exception has occurred.

toXml

public static void toXml(InputStream properties,
                         OutputStream xml,
                         String comment,
                         String encoding)
                  throws IOException

Converts the given properties InputStream to the given xml OutputStream.

Parameters:

properties - the properties InputStream.

xml - the xml OutputStream to write in.

comment - the comment

encoding - the encoding for the xml file.

Throws:

IOException - Signals that an I/O exception has occurred.

getInteger

public static Optional<Integer> getInteger(Properties properties,
                                           String propertiesKey)

Try to get a number from the given properties key from the given properties. If it does not exists an empty Optional will be returned and a log message will be logged.

Parameters:

properties - the properties

propertiesKey - the properties key

Returns:

the port number or an empty Optional