io.rincl

Class EmptyResources

java.lang.Object

io.rincl.AbstractResources

io.rincl.EmptyResources

All Implemented Interfaces:

Resources

public final class EmptyResources
extends AbstractResources

An implementation of resources that contains no definitions.

This implementation will automatically delegate to the parent resources, if any.

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor and Description
EmptyResources(Class<?> contextClass) Context class constructor.
EmptyResources(Class<?> contextClass, Optional<Resources> parentResources) Context class and optional parent resources constructor.
EmptyResources(Class<?> contextClass, Resources parentResources) Context class and parent resources constructor.

Method Summary

Modifier and Type	Method and Description
Optional<Boolean>	getOptionalBoolean(String key) Retrieves a Boolean resource that may not be present.
Optional<Double>	getOptionalDouble(String key) Retrieves a floating point resource that may not be present.
Optional<Integer>	getOptionalInt(String key) Retrieves an integer resource that may not be present.
Optional<String>	getOptionalString(String key, Object... arguments) Retrieves a string resource that may not be present.
boolean	hasResource(String key) Determines whether a resource of some type exists for the given resource key.

Methods inherited from class io.rincl.AbstractResources

getContextClass, getParentResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rincl.Resources

getBoolean, getDouble, getInt, getString, requireResource

Constructor Detail

EmptyResources

public EmptyResources(@Nonnull
                      Class<?> contextClass)

Context class constructor.

Parameters:

contextClass - The context with which these resources are related; usually the class of the object requesting the resource.

Throws:

NullPointerException - if the given context class is null.

EmptyResources

public EmptyResources(@Nonnull
                      Class<?> contextClass,
                      @Nonnull
                      Resources parentResources)

Context class and parent resources constructor.

Parameters:

contextClass - The context with which these resources are related; usually the class of the object requesting the resource.

parentResources - The parent resources for fallback lookup.

Throws:

NullPointerException - if the given context class and/or parent resources is null.

EmptyResources

public EmptyResources(@Nonnull
                      Class<?> contextClass,
                      @Nonnull
                      Optional<Resources> parentResources)

Context class and optional parent resources constructor.

Parameters:

contextClass - The context with which these resources are related; usually the class of the object requesting the resource.

parentResources - The parent resources for fallback lookup.

Throws:

NullPointerException - if the given context class and/or parent resources is null.

Method Detail

hasResource

public boolean hasResource(String key)
                    throws ResourceConfigurationException

Description copied from interface: Resources

Determines whether a resource of some type exists for the given resource key.

This method searches the parent resources hierarchy if no resource is available in this instance.

Parameters:

key - The resource key.

Returns:

true if a resource of type type could be retrieved from these resources using the given key.

Throws:

ResourceConfigurationException - if there is a resource value stored in an invalid format.

getOptionalBoolean

public Optional<Boolean> getOptionalBoolean(String key)
                                     throws ResourceConfigurationException

Description copied from interface: Resources

Retrieves a Boolean resource that may not be present.

Parameters:

key - The resource key.

Returns:

The optional value of the resource associated with the given key.

Throws:

ResourceConfigurationException - if there is a resource value stored in an invalid format.

getOptionalInt

public Optional<Integer> getOptionalInt(String key)
                                 throws ResourceConfigurationException

Description copied from interface: Resources

Retrieves an integer resource that may not be present.

Parameters:

key - The resource key.

Returns:

The optional value of the resource associated with the given key.

Throws:

ResourceConfigurationException - if there is a resource value stored in an invalid format.

getOptionalDouble

public Optional<Double> getOptionalDouble(String key)
                                   throws ResourceConfigurationException

Description copied from interface: Resources

Retrieves a floating point resource that may not be present.

Parameters:

key - The resource key.

Returns:

The optional value of the resource associated with the given key.

Throws:

ResourceConfigurationException - if there is a resource value stored in an invalid format.

getOptionalString

public Optional<String> getOptionalString(String key,
                                          Object... arguments)
                                   throws ResourceConfigurationException

Description copied from interface: Resources

Retrieves a string resource that may not be present.

TODO discuss dereferencing

If arguments are provided, the string if present will be considered a template and formatted applying the given arguments. Formatting takes place after replacement of all internal resource references. The MessageFormat formatting rules will be used.

Parameters:

key - The resource key.

arguments - The arguments for formatting, if any.

Returns:

The optional value of the resource associated with the given key.

Throws:

ResourceConfigurationException - if there is a resource value stored in an invalid format.

See Also:

Format.format(Object)