Enum Class PropertyFileUtil.PropertyFileUtilFileKindEnum

java.lang.Object

java.lang.Enum<PropertyFileUtil.PropertyFileUtilFileKindEnum>

jp.ecuacion.lib.core.util.PropertyFileUtil.PropertyFileUtilFileKindEnum

All Implemented Interfaces:

Serializable, Comparable<PropertyFileUtil.PropertyFileUtilFileKindEnum>, Constable

Enclosing class:

PropertyFileUtil

public static enum PropertyFileUtil.PropertyFileUtilFileKindEnum
extends Enum<PropertyFileUtil.PropertyFileUtilFileKindEnum>

Holds kinds of property files.

The first argument of the enum value (like "application", "messages", ...) is called filePrefix, which is the file literally the prefix of the property files.
But in some reasons some properties file kind need to have multiple file prefixes so the second argument actualFilePrefixes needed.

actualFilePrefixes is a data type of String[][]. If you want to simply use multiple prefixes, it's realized by new String[][] {new String[] {messages1, messages2}}. With this prefix setting PropertyFileUtilValueGetter searches the key from files with these prefixes, and duplication of the key causes an error.

When you know messages1 and messages2 has duplication and if messages1 contains the key you don't want to search from messages2, it can be realized by this setting.
new String[][] {new String[] {messages1}, new String[] {messages2}}.
Outside array manipulates the priority of the property files.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION	application.properties.
ENUM_NAMES	enum_names.
ITEM_NAMES	item_names.
MESSAGES	messages.properties.
MESSAGES_WITH_ITEM_NAMES	messagesWithItemNames.properties.
STRINGS	strings.properties.
VALIDATION_MESSAGES	ValidationMessags.
VALIDATION_MESSAGES_PATTERN_DESCRIPTIONS
VALIDATION_MESSAGES_WITH_ITEM_NAMES	ValidationMessagsWithField.

Method Summary

Modifier and Type	Method	Description
String[][]	getActualFilePrefixes()
boolean	throwsExceptionWhenKeyDoesNotExist()	Returns throwsExceptionWhenKeyDoesNotExist.
static PropertyFileUtil.PropertyFileUtilFileKindEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertyFileUtil.PropertyFileUtilFileKindEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APPLICATION

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum APPLICATION

application.properties.

MESSAGES

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum MESSAGES

messages.properties.

MESSAGES_WITH_ITEM_NAMES

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum MESSAGES_WITH_ITEM_NAMES

messagesWithItemNames.properties.

Generally, messages.properties is supposed to be used for messages, and messagesWithItemNames is not very understandable for users. Besides that, since the case that both messages.properties and messagesWithItemNames.properties are used is very rare, it's better for messages.properties to be used even when you treat "messages with item names" without that rare case. That's why messages.properties is also contained with this value.

STRINGS

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum STRINGS

strings.properties.

ITEM_NAMES

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum ITEM_NAMES

item_names.

ENUM_NAMES

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum ENUM_NAMES

enum_names.

VALIDATION_MESSAGES

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum VALIDATION_MESSAGES

ValidationMessags.

VALIDATION_MESSAGES_WITH_ITEM_NAMES

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum VALIDATION_MESSAGES_WITH_ITEM_NAMES

ValidationMessagsWithField.

VALIDATION_MESSAGES_PATTERN_DESCRIPTIONS

public static final PropertyFileUtil.PropertyFileUtilFileKindEnum VALIDATION_MESSAGES_PATTERN_DESCRIPTIONS

Method Details

values

public static PropertyFileUtil.PropertyFileUtilFileKindEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PropertyFileUtil.PropertyFileUtilFileKindEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getActualFilePrefixes

public String[][] getActualFilePrefixes()

throwsExceptionWhenKeyDoesNotExist

public boolean throwsExceptionWhenKeyDoesNotExist()

Returns throwsExceptionWhenKeyDoesNotExist.