r01f.xmlproperties
Class XMLPropertyWrapper

java.lang.Object
  r01f.xmlproperties.XMLPropertyWrapper

public final class XMLPropertyWrapper
extends java.lang.Object

Encapsula las propiedades de R01F.

El uso típico es el siguiente:

Crear una clase que encapsula el acceso a las propiedades de un código de aplicación y crear un inyector GUICE responsable de dar acceso al singleton, indicando en el constructor:
• número estimado de componentes (ficheros de propiedades).
• número estimado de propiedades por componente.

                public class XXProps {
                        private static Injector injector = Guice.createInjector(new XMLPropertiesGuiceModule(1,50));
                }
                

Dar acceso a las propiedades creando un método llamado por ejemplo "at"


OPCION 1: Hay un solo componente llamado por ejemplo "default"

                                public static XMLPropertyWrapper at(final String xPath) {
                                        XMLPropertiesManager props = injector.getInstance(XMLPropertiesManager.class);
                                        XMLPropertyWrapper prop = new XMLPropertyWrapper(props.of("xx","default"),xPath);
                                        return prop;
                                }
                                

OPCION 2: Hay varios componentes

                                public static XMLPropertyWrapper at(final String comp,final String xPath) {
                                        XMLPropertiesManager props = injector.getInstance(XMLPropertiesManager.class);
                                        XMLPropertyWrapper prop = new XMLPropertyWrapper(props.of("xx",comp),xPath);
                                        return prop;
                                }
                                

o también es posible:

                                public static XMLPropertyWrapper inCompYAt(final String xPath) {
                                        XMLPropertiesManager props = injector.getInstance(XMLPropertiesManager.class);
                                        XMLPropertyWrapper prop = new XMLPropertyWrapper(props.of("xx","compY"),xPath);
                                        return prop;
                                }
                                

Acceder a las propiedades a través de la clase XXProps:

                String myStringProp = XXProps.at(xPath).asString(defaultValue);
                

Field Summary

private XMLPropertiesManager.ComponentProperties	_props
private java.lang.String	_xPath

Constructor Summary

XMLPropertyWrapper()

Method Summary

boolean	asBoolean() El valor de la propiedad como un objeto booleano.
boolean	asBoolean(boolean defaultVal) Devuelve la propiedad como un Boolean.
float	asFloat() El valor de la propiedad como un objeto complejo.
float	asFloat(float defaultVal) Devuelve la propiedad como un Float.
int	asInteger() El valor de la propiedad como un objeto entero.
int	asInteger(int defaultVal) Devuelve la propiedad como un Integer.
java.util.List<java.lang.String>	asListOfStrings() La propiedad como una lista de cadenas.
java.util.List<java.lang.String>	asListOfStrings(java.util.List<java.lang.String> defaultVal) Devuelve la propiedad como un List de String.
java.util.List<java.lang.String>	asListOfStrings(java.lang.String... defaultStrings) Devuelve la propiedad como un List de String.
java.lang.Number	asNumber() El valor de la propiedad como un objeto numérico.
java.lang.Number	asNumber(java.lang.Number defaultVal) Devuelve la propiedad como un Number.
<T> T	asObject(java.lang.Class<T> objType, Marshaller marshaller) Devuelve la propiedad como un objeto obtenido transformando de XML a objetos con el marshaller de R01.
java.util.Properties	asProperties() La propiedad como un objeto de tipo propiedad.
java.util.Properties	asProperties(java.util.Properties defaultVal) Devuelve la propiedad como un Properties.
ResourcesLoaderDef	asResourcesLoaderDef() Devuelve la propiedad como un objeto de definición de carga de recursos ResourcesLoaderDef (obviamente el XML tiene que tener la estrucutra impuesta por ResourcesLoaderDef).
java.lang.String	asString() Obtiene el valor de la propiedad como una cadena.
java.lang.String	asString(java.lang.String defaultVal) Devuelve la propiedad como String.
Strings.StringWrapper	asStringWrapped() Obtiene la propiedad como un wrapper.
Strings.StringWrapper	asStringWrapped(java.lang.String defaultVal) Devuelve la propiedad como un Strings.StringWrapper.
boolean	exist() Comprueba si la propiedad existe.

Methods inherited from class java.lang.Object

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

Field Detail

_props

private XMLPropertiesManager.ComponentProperties _props

_xPath

private java.lang.String _xPath

Constructor Detail

XMLPropertyWrapper

public XMLPropertyWrapper()

Method Detail

exist

public boolean exist()

Comprueba si la propiedad existe.

Returns:

true si existe la propiedad.

asString

public java.lang.String asString()

Obtiene el valor de la propiedad como una cadena.

Returns:

La propiedad como un String.

asString

public java.lang.String asString(java.lang.String defaultVal)

Devuelve la propiedad como String.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asStringWrapped

public Strings.StringWrapper asStringWrapped()

Obtiene la propiedad como un wrapper.

Returns:

La propiedad como un Strings.StringWrapper.

asStringWrapped

public Strings.StringWrapper asStringWrapped(java.lang.String defaultVal)

Devuelve la propiedad como un Strings.StringWrapper.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asNumber

public java.lang.Number asNumber()

El valor de la propiedad como un objeto numérico.

Returns:

La propiedad como un Number.

asNumber

public java.lang.Number asNumber(java.lang.Number defaultVal)

Devuelve la propiedad como un Number.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asInteger

public int asInteger()

El valor de la propiedad como un objeto entero.

Returns:

La propiedad como un Integer.

asInteger

public int asInteger(int defaultVal)

Devuelve la propiedad como un Integer.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asFloat

public float asFloat()

El valor de la propiedad como un objeto complejo.

Returns:

la propiedad como un Float.

asFloat

public float asFloat(float defaultVal)

Devuelve la propiedad como un Float.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asBoolean

public boolean asBoolean()

El valor de la propiedad como un objeto booleano.

Returns:

La propiedad como un Boolean.

asBoolean

public boolean asBoolean(boolean defaultVal)

Devuelve la propiedad como un Boolean.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asProperties

public java.util.Properties asProperties()

La propiedad como un objeto de tipo propiedad.

Returns:

la propiedad como un Properties.

asProperties

public java.util.Properties asProperties(java.util.Properties defaultVal)

Devuelve la propiedad como un Properties.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asListOfStrings

public java.util.List<java.lang.String> asListOfStrings()

La propiedad como una lista de cadenas.

Returns:

La propiedad como un List de String.

asListOfStrings

public java.util.List<java.lang.String> asListOfStrings(java.util.List<java.lang.String> defaultVal)

Devuelve la propiedad como un List de String.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asListOfStrings

public java.util.List<java.lang.String> asListOfStrings(java.lang.String... defaultStrings)

Devuelve la propiedad como un List de String.

Parameters:

defaultVal - El valor por defecto si la propiedad NO se encuentra definida.

Returns:

El valor de la propiedad o el valor por defecto si la propiedad NO se encuentra definida.

asObject

public <T> T asObject(java.lang.Class<T> objType,
                      Marshaller marshaller)

Devuelve la propiedad como un objeto obtenido transformando de XML a objetos con el marshaller de R01.

Parameters:

objType - Tipo del objeto devuelto.

marshaller - El marshaller con la definición de la transformación de XML a objetos.

Returns:

La propiedad como objeto.

asResourcesLoaderDef

public ResourcesLoaderDef asResourcesLoaderDef()

Devuelve la propiedad como un objeto de definición de carga de recursos ResourcesLoaderDef (obviamente el XML tiene que tener la estrucutra impuesta por ResourcesLoaderDef).

Returns:

un objeto ResourcesLoaderDef

See Also:

ResourcesLoaderDef