Module jp.ecuacion.lib.core

Package jp.ecuacion.lib.core.util

Class PropertyFileUtil

java.lang.Object

jp.ecuacion.lib.core.util.PropertyFileUtil

public class PropertyFileUtil
extends Object

Provides utility methods to read *.properties files.

It has following functions added to ResourceBundle class packaged in JRE.

1. To read all the ".properties" files in library modules and multiple modules in app projects
2. To read multiple kinds of ".properties" (application, messages, enum_names, field_names)
3. To use "default" message by putting the postfix of the message ID ".default"
4. To have the override function by java launch parameter (-D) or System.setProperty(...)
5. To have the default locale setting function by .properties file (application_for_property-file-util_base.properties)

1. To read all the ".properties" files in library modules and multiple modules in app projects

If we talk about messages[_xxx].properties, this class reads ones in ecuacion libraries, and ones in your apps.
In ecuacion libraries an app is assumed to devided to some modules (=usually called "projects" in IDE), which are base, core, web (or none), batch.

If the name of your app is sample-app, module names would be :
sample-app-base : messages_base.properties
sample-app-core : messages_core.properties
sample-app-web : messages.properties
sample-app-batch: messages.properties

PropertyFileUtil.getMsg(...) will read all the messages properties above.
Duplicated definition detectable. (causes throwing exception)

And of course you can use localized files like messages_core_ja.properties because This class uses ResourceBundle inside to read properties files.

2. To read multiple kinds of ".properties" (application, messages, enum_names, field_names)

Firstly, In ecuacion-lib we have 4 kinds of property files.

PropertyFileUtil.getMsg(...) : messages[_xxx].properties
PropertyFileUtil.getApp(...) : application[_xxx].properties
PropertyFileUtil.getEnumName(...) : enum_names[_xxx].properties
PropertyFileUtil.getFieldName(...) : fiels_names[_xxx].properties

messages.properties and application.properties are well-known.
enum_names.properties stores the localized name of the enum element, and field_names.properties stores the localized name of the entity field.
Usually these are also stored in messages.properties, but it's kind of messy so divided files are prepared.

PropertyFileUtil supports these 4 kinds of properties files.

kinds of property files

kind	data the file has
application	system settings
messages	messages
field_names	names of the fields of items
enum_names	names of the elements of enums

3. To use "default" message by putting the postfix of the message ID ".default"

4. To Have the override function by java launch parameter (-D) or System.setProperty(...)

5. To Have the default locale setting function by .properties file (application_for_property-file-util_base.properties)

When you don't prepare the properties file, values are obtained from properties files without locale specification (like message.properties, not like messages_en.properties).
ResourceBundle uses Locale.getDefault() but this is not good because the resulting locale depends on the PC or the server the program is executing.
Of course when you want to depends on the PC or the server, you just have to explicitly pass Locale.getDefault() to it.

Miscellaneous

messages[_xxx].properties, enum_names[_xxx].properties, fiels_names[_xxx].properties need to have default locale file (like messages.properties. This is the rule of the library.
It leads the conclusion that hasXxx(...) (like hasMsg(...)) doesn't need to have locale argument. (default locale used)

Method Summary

Modifier and Type	Method	Description
static void	addResourceBundlePostfix(String postfix)	Adds postfix dinamically.
static String	getApp(String key)	Returns the value in application_xxx.properties.
static String	getEnumName(String key)	Returns the enum name of default locale in enum_names_xxx.properties.
static String	getEnumName(Locale locale, String key)	Returns the localized enum name in enum_names_xxx.properties.
static String	getFieldName(String key)	Returns the field name of default locale in field_names_xxx.properties.
static String	getFieldName(Locale locale, String key)	Returns the localized field name in field_names_xxx.properties.
static String	getMsg(String key, String... args)	Returns the value in application_xxx.properties.
static String	getMsg(Locale locale, String key, String... args)	Returns the value in messages_xxx.properties.
static boolean	hasApp(String key)	Returns the existence of the key in application_xxx.properties.
static boolean	hasEnumName(String key)	Returns the existence of the key in enam_names_xxx.properties.
static boolean	hasFieldName(String key)	Returns the existence of the key in field_names_xxx.properties.
static boolean	hasMsg(String msgId)	Returns the existence of the key in field_names_xxx.properties.

Methods inherited from class java.lang.Object

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

Method Details

getApp

@Nonnull
public static String getApp(@RequireNonnull
 String key)

Returns the value in application_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

Returns:

the value of the property

hasApp

public static boolean hasApp(@RequireNonnull
 String key)

Returns the existence of the key in application_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

Returns:

boolean value that shows whether properties has the key

getMsg

@Nonnull
public static String getMsg(@RequireNonnull
 String key,
 @RequireNonnull
 String... args)

Returns the value in application_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

args - message arguments, may be null which is treated as new String[] {}.

Returns:

the message corresponding to the message ID

getMsg

@Nonnull
public static String getMsg(@Nullable
 Locale locale,
 @RequireNonnull
 String key,
 @RequireNonnull
 String... args)

Returns the value in messages_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

locale - locale, may be null which means no Locale specified.

key - the key of the property

args - message arguments, may be null which is treated as new String[] {}.

Returns:

the message corresponding to the message ID

hasMsg

public static boolean hasMsg(@RequireNonnull
 String msgId)

Returns the existence of the key in field_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

msgId - message ID

Returns:

boolean value that shows whether properties has the message ID

getFieldName

@Nonnull
public static String getFieldName(@RequireNonnull
 String key)

Returns the field name of default locale in field_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

Returns:

the value of the property

getFieldName

@Nonnull
public static String getFieldName(@Nullable
 Locale locale,
 @RequireNonnull
 String key)

Returns the localized field name in field_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

locale - locale, may be null which is treated as Locale.getDefault().

key - the key of the property

Returns:

the value of the property

hasFieldName

public static boolean hasFieldName(@RequireNonnull
 String key)

Returns the existence of the key in field_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

Returns:

boolean value that shows whether properties has the key

getEnumName

@Nonnull
public static String getEnumName(@RequireNonnull
 String key)

Returns the enum name of default locale in enum_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

Returns:

the value of the property

getEnumName

@Nonnull
public static String getEnumName(@Nullable
 Locale locale,
 @RequireNonnull
 String key)

Returns the localized enum name in enum_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

locale - locale, may be null which is treated as Locale.getDefault().

key - the key of the property

Returns:

the value of the property

hasEnumName

public static boolean hasEnumName(@RequireNonnull
 String key)

Returns the existence of the key in enam_names_xxx.properties.

Names should exist but some function uses this to show message ID when the key does not exist in the file.

Parameters:

key - the key of the property

Returns:

boolean value that shows whether properties has the key

addResourceBundlePostfix

public static void addResourceBundlePostfix(String postfix)

Adds postfix dinamically.

If you add test for example, messages_test[_xxx].properties, application_test[_xxx.properties, ...} are searched.

Parameters:

postfix - postfix