abk.messages
Class AResourceKey

java.lang.Object
  abk.messages.AResourceKey

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AMessageKey

public class AResourceKey
extends Object
implements Serializable

Clase que representa una clave para acceder a un recurso de un ResourceBundle.

See Also:

Serialized Form

Field Summary

private Serializable	iBaseName Nombre base del fichero de recursos.
private String	iKey Clave del recurso.

Constructor Summary

protected	AResourceKey(AResourceKey key) Constructor a partir de otra instancia de AResourceKey o descendiente.
protected	AResourceKey(File baseName, String key)
protected	AResourceKey(String baseName, String key) Constructor a partir de una cadena de texto con el nombre de la clave.

Method Summary

boolean	equals(Object obj)
(package private) static Serializable[]	evalResourceKeys(Locale locale, Serializable... args)
String[]	getArray(Locale locale)
String	getBaseName() Devuelve el nombre base del fichero de propiedades donde está el recursos con la clave indicada.
ResourceBundle	getBundle(Locale locale) Devuelve el ResourceBundle asociado al nombre base para un idioma concreto.
String	getKey() Devuelve la clave como cadena de texto.
String	getString(Locale locale)
int	hashCode()
private IllegalStateException	illegalBaseNameException()
AResourceKey	newKey(String key) Crea una clave nueva con el mismo nombre base.
AMessage	newMessage(Locale locale, Serializable... args)
AMessagePattern	newPattern(Locale locale) Devuelve el patrón obtenido a partir de una clave de recursos.
static AResourceKey	resourceOf(File baseName, String key)
static AResourceKey	resourceOf(String baseName, String key) Atajo para construir un AResourceKey de forma rápida.
String	toString() Devuelve la clave del recurso como cadena de texto.

Methods inherited from class java.lang.Object

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

Field Detail

iBaseName

private final Serializable iBaseName

Nombre base del fichero de recursos.

iKey

private final String iKey

Clave del recurso.

Constructor Detail

AResourceKey

protected AResourceKey(String baseName,
                       String key)

Constructor a partir de una cadena de texto con el nombre de la clave.

Parameters:

baseName - Nombre base del ResourceBundle con las propiedades a la que se refiere la clave.

key - Nombre de la clave.

Throws:

NullArgumentException - si baseName o key son nulos.

IllegalArgumentException - si baseName o key están vacíos.

AResourceKey

protected AResourceKey(File baseName,
                       String key)

AResourceKey

protected AResourceKey(AResourceKey key)

Constructor a partir de otra instancia de AResourceKey o descendiente.

Parameters:

key - Clave de recurso que se copia.

Throws:

NullPointerException - si key es nulo.

Method Detail

resourceOf

public static final AResourceKey resourceOf(String baseName,
                                            String key)

Atajo para construir un AResourceKey de forma rápida.

El uso previsto es:

 import static es.jcyl.cct.core.text.AResourceKey.resourceOf;
 
 class Xyy {
    public static final AResourceKey KEY_ALGO = resourceOf("key.algo");
 }
 

Parameters:

key - Clave del recurso.

Returns:

Instancia con key como clave.

resourceOf

public static final AResourceKey resourceOf(File baseName,
                                            String key)

getKey

public String getKey()

Devuelve la clave como cadena de texto.

Returns:

Clave almacenada como cadena de texto.

getBaseName

public String getBaseName()

Devuelve el nombre base del fichero de propiedades donde está el recursos con la clave indicada.

Returns:

El nombre base del fichero de propiedades donde está el recursos con la clave indicada.

illegalBaseNameException

private IllegalStateException illegalBaseNameException()

newKey

public AResourceKey newKey(String key)

Crea una clave nueva con el mismo nombre base.

Parameters:

key - Clave del recurso.

Returns:

Instancia para la nueva clase y mismo nombre base de recursos.

toString

public String toString()

Devuelve la clave del recurso como cadena de texto.

Overrides:

toString in class Object

Returns:

Una cadena de tipo ${key}.

getBundle

public ResourceBundle getBundle(Locale locale)

Devuelve el ResourceBundle asociado al nombre base para un idioma concreto.

Parameters:

locale - Especificación de idioma para la que pedimos el objeto.

Returns:

El ResourceBundle asociado al nombre base para un idioma concreto.

Throws:

NullPointerException - si locale es nulo.

MissingResourceException - si no se puede resolver el nombre base.

See Also:

ResourceBundle.getBundle(String, Locale)

getString

public String getString(Locale locale)

getArray

public String[] getArray(Locale locale)

newPattern

public AMessagePattern newPattern(Locale locale)

Devuelve el patrón obtenido a partir de una clave de recursos.

Parameters:

locale - Idioma para el patrón.

Returns:

Instancia de patrón para esa clave e idioma.

newMessage

public AMessage newMessage(Locale locale,
                           Serializable... args)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

evalResourceKeys

static final Serializable[] evalResourceKeys(Locale locale,
                                             Serializable... args)