c10n.share.utils

Class C10NBundleKey

java.lang.Object

c10n.share.utils.C10NBundleKey

public class C10NBundleKey
extends Object

A bundle key used to look up the translation in a ResourceBundle.

Bundle key consists of the the key actually used to look up in the bundle, as well as the key, declared by the user, using C10NKey annotaion, if any. If the C10NKey annotation has in any way affected the bundle key generation process, i.e. either the annotation was declared on the enclosing class or on the method itself, then the bundle key is considered custom (isCustomKey() will be true).

Since:

1.1

Author:

rodion

Constructor Summary

Constructors

Constructor and Description
C10NBundleKey(boolean customKey, String key, String declaredKey)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDeclaredKey() The bundle key as it appeared in the C10NKey annotation value.
String	getKey() The bundle key used for retrieval from the bundle.
int	hashCode()
boolean	isCustomKey() Determines whether the key was automatically generated by c10n, or customised by the user using the C10NKey annotation, either on one of the parent classes, or the method directly, or both.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

C10NBundleKey

public C10NBundleKey(boolean customKey,
             String key,
             String declaredKey)

Method Detail

isCustomKey

public boolean isCustomKey()

Determines whether the key was automatically generated by c10n, or customised by the user using the C10NKey annotation, either on one of the parent classes, or the method directly, or both.

Returns:

If key is customised, true, else false.

getKey

public String getKey()

The bundle key used for retrieval from the bundle.

Returns:

bundle key(not null)

getDeclaredKey

public String getDeclaredKey()

The bundle key as it appeared in the C10NKey annotation value. If annotation was not specified, returns null

Returns:

value of the C10NKey annotation, or null if none was declared.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object