io.rincl

Interface Resources

All Known Implementing Classes:

AbstractResources, AbstractStringResources, BaseResources, EmptyResources

public interface Resources

Access to i18n resources.

Each resource lookup method such as getString(String, Object...) is expected to attempt to look up resources in the getParentResources() (if any) if the resource is not found in this resources instance.

Author:

Garret Wilson

Method Summary

Modifier and Type	Method and Description
default boolean	getBoolean(String key) Retrieves a Boolean resource.
Class<?>	getContextClass()
default double	getDouble(String key) Retrieves a floating point resource.
default int	getInt(String key) Retrieves an integer resource.
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.
Optional<Resources>	getParentResources()
default String	getString(String key, Object... arguments) Retrieves a string resource.
boolean	hasResource(String key) Determines whether a resource of some type exists for the given resource key.
default <T> T	requireResource(Optional<T> resource, String key) Retrieves a required resource from an Optional, throwing a MissingResourceException if the resource not present.

Method Detail

getParentResources

Optional<Resources> getParentResources()

Returns:

The parent resources for fallback lookup.

getContextClass

@Nonnull
Class<?> getContextClass()

Returns:

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

requireResource

default <T> T requireResource(@Nonnull
                              Optional<T> resource,
                              @Nonnull
                              String key)
                       throws MissingResourceException

Retrieves a required resource from an Optional, throwing a MissingResourceException if the resource not present.

This method is primarily used to check the result of a resource lookup call for the non-optional convenience resource lookup versions.

Type Parameters:

T - The type of resource to check.

Parameters:

resource - The retrieved resource.

key - The resource key.

Returns:

The retrieved resource.

Throws:

MissingResourceException - if the given resource is not present.

See Also:

Optional.isPresent()

hasResource

boolean hasResource(@Nonnull
                    String key)
             throws ResourceConfigurationException

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:

NullPointerException - if the given key is null.

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

getBoolean

@Nonnull
default boolean getBoolean(@Nonnull
                                     String key)
                              throws MissingResourceException,
                                     ResourceConfigurationException

Retrieves a Boolean resource.

Parameters:

key - The resource key.

Returns:

The value of the resource associated with the given key.

Throws:

NullPointerException - if the given key is null.

MissingResourceException - if no resource is associated with the given key.

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

getOptionalBoolean

Optional<Boolean> getOptionalBoolean(@Nonnull
                                     String key)
                              throws ResourceConfigurationException

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:

NullPointerException - if the given key is null.

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

getDouble

@Nonnull
default double getDouble(@Nonnull
                                   String key)
                            throws MissingResourceException,
                                   ResourceConfigurationException

Retrieves a floating point resource.

Parameters:

key - The resource key.

Returns:

The value of the resource associated with the given key.

Throws:

NullPointerException - if the given key is null.

MissingResourceException - if no resource is associated with the given key.

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

getOptionalDouble

Optional<Double> getOptionalDouble(@Nonnull
                                   String key)
                            throws ResourceConfigurationException

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:

NullPointerException - if the given key is null.

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

getInt

@Nonnull
default int getInt(@Nonnull
                             String key)
                      throws MissingResourceException,
                             ResourceConfigurationException

Retrieves an integer resource.

Parameters:

key - The resource key.

Returns:

The value of the resource associated with the given key.

Throws:

NullPointerException - if the given key is null.

MissingResourceException - if no resource is associated with the given key.

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

getOptionalInt

Optional<Integer> getOptionalInt(@Nonnull
                                 String key)
                          throws ResourceConfigurationException

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:

NullPointerException - if the given key is null.

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

getString

@Nonnull
default String getString(@Nonnull
                                   String key,
                                   @Nonnull
                                   Object... arguments)
                            throws MissingResourceException,
                                   ResourceConfigurationException

Retrieves a string resource.

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 value of the resource associated with the given key.

Throws:

NullPointerException - if the given key is null.

MissingResourceException - if no resource is associated with the given key.

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

See Also:

Format.format(Object)

getOptionalString

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

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:

NullPointerException - if the given key is null.

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

See Also:

Format.format(Object)