de.alpharogroup.resourcebundle.properties

Class PropertiesExtensions

java.lang.Object

de.alpharogroup.resourcebundle.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.

Method Summary

Modifier and Type	Method and Description
static Map<String,List<String>>	findRedundantValues(Properties properties) Finds redundant values from the given Properties object and saves it to a Map.
static Properties	getLocalPropertiesFromClass(Class<?> componentClass, Class<?> defaultClass, Locale locale) Gets the properties.
static Map<String,List<String>>	getMatchedPrefixLists(Properties enProperties) 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(Class<?> clazz, String name) Load properties.
static Properties	loadProperties(Class<?> clazz, String packagePath, String fileName) Load properties.
static Properties	loadProperties(File propertiesFile) Load a Properties-object from the given File-object.
static Properties	loadProperties(String packagePath) Gives a Properties-object from the given packagepath.
static Properties	loadProperties(String packagePath, String fileName) Load properties.
static <T> Properties	loadProperties(T object, String propertiesFilename) Load Properties object from the given arguments.
static Properties	loadPropertiesFromClassObject(Class<?> clazz, Locale locale) Load the properties file from the given class object.
static Set<String>	resolveAvailableLanguages(String bundlepackage, String bundlename) Resolves all the available languages for the given resource bundle name in the given bundle package.
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	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.

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.

getLocalPropertiesFromClass

public static Properties getLocalPropertiesFromClass(Class<?> componentClass,
                                                     Class<?> defaultClass,
                                                     Locale locale)
                                              throws Exception

Gets the properties.

Parameters:

componentClass - the component class

defaultClass - the default class

locale - the locale

Returns:

the properties

Throws:

Exception - the exception

getMatchedPrefixLists

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

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:

enProperties - 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(Class<?> clazz,
                                        String name)
                                 throws IOException

Load properties.

Parameters:

clazz - the clazz

name - the package path with the file name

Returns:

the properties

Throws:

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

loadProperties

public static <T> Properties loadProperties(T object,
                                            String propertiesFilename)

Load Properties object from the given arguments.

Type Parameters:

T - the generic type of the object

Parameters:

object - the object for get the package path

propertiesFilename - the properties filename

Returns:

the loaded Properties or null if the loading process failed.

loadProperties

public static Properties loadProperties(Class<?> clazz,
                                        String packagePath,
                                        String fileName)
                                 throws IOException

Load properties.

Parameters:

clazz - the clazz

packagePath - the package path without the file name

fileName - the file name

Returns:

the properties

Throws:

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

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(String packagePath)
                                 throws IOException

Gives a Properties-object from the given packagepath.

Parameters:

packagePath - The package-path and the name from the resource as a String.

Returns:

The Properties-object from the given packagepath.

Throws:

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

loadProperties

public static Properties loadProperties(String packagePath,
                                        String fileName)
                                 throws IOException

Load properties.

Parameters:

packagePath - the package path without the file name

fileName - the file name

Returns:

the properties

Throws:

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

loadPropertiesFromClassObject

public static Properties loadPropertiesFromClassObject(Class<?> clazz,
                                                       Locale locale)
                                                throws IOException

Load the properties file from the given class object. The filename from the properties file is the same as the simple name from the class object and it looks at the same path as the given class object. If locale is not null than the language will be added to the filename from the properties file.

Parameters:

clazz - the clazz

locale - the locale

Returns:

the properties

Throws:

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

resolveAvailableLanguages

public static Set<String> resolveAvailableLanguages(String bundlepackage,
                                                    String bundlename)

Resolves all the available languages for the given resource bundle name in the given bundle package. Note the default resource bundle is excluded.

Parameters:

bundlepackage - The package that contains the properties files.

bundlename - The name of the resource bundle.

Returns:

a Set of String objects with the available languages excluding the default.

toProperties

public static void toProperties(File properties,
                                File xml,
                                String comment)
                         throws FileNotFoundException,
                                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:

FileNotFoundException - the file not found exception

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

toProperties

public static void toProperties(OutputStream properties,
                                InputStream xml,
                                String comment)
                         throws FileNotFoundException,
                                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:

FileNotFoundException - the file not found exception

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

toXml

public static void toXml(File properties,
                         File xml,
                         String comment,
                         String encoding)
                  throws FileNotFoundException,
                         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:

FileNotFoundException - the file not found exception

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

toXml

public static void toXml(InputStream properties,
                         OutputStream xml,
                         String comment,
                         String encoding)
                  throws FileNotFoundException,
                         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:

FileNotFoundException - the file not found exception

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