org.codehaus.griffon.runtime.core.resources

Class AbstractResourceResolver

java.lang.Object

org.codehaus.griffon.runtime.core.resources.AbstractResourceResolver

All Implemented Interfaces:

ResourceResolver

Direct Known Subclasses:

CompositeResourceResolver, DefaultResourceResolver

public abstract class AbstractResourceResolver
extends Object
implements ResourceResolver

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object[]	EMPTY_OBJECT_ARGS
protected static String	ERROR_ARGS_NULL
protected static String	ERROR_KEY_BLANK
protected static String	ERROR_LOCALE_NULL
protected static String	ERROR_RESOURCE_BLANK

Fields inherited from interface griffon.core.resources.ResourceResolver

REF_KEY_END, REF_KEY_START

Constructor Summary

Constructors

Constructor and Description
AbstractResourceResolver()

Method Summary

Modifier and Type	Method and Description
protected abstract Object	doResolveResourceValue(String key, Locale locale)
protected Object	evalResourceWithArguments(Object resource, Map<String,Object> args)
protected Object	evalResourceWithArguments(Object resource, Object[] args)
String	formatResource(String resource, List<?> args) Formats the given resource using supplied args to substitute placeholders.
String	formatResource(String resource, Map<String,Object> args) Formats the given resource using supplied args to substitute placeholders.
String	formatResource(String resource, Object[] args) Formats the given resource using supplied args to substitute placeholders.
Object	resolveResource(String key) Try to resolve the resource.
Object	resolveResource(String key, List<?> args) Try to resolve the resource.
Object	resolveResource(String key, List<?> args, Locale locale) Try to resolve the resource.
Object	resolveResource(String key, List<?> args, Locale locale, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, List<?> args, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, Locale locale) Try to resolve the resource.
Object	resolveResource(String key, Locale locale, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, Map<String,Object> args) Try to resolve the resource.
Object	resolveResource(String key, Map<String,Object> args, Locale locale) Try to resolve the resource.
Object	resolveResource(String key, Map<String,Object> args, Locale locale, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, Map<String,Object> args, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, Object[] args) Try to resolve the resource.
Object	resolveResource(String key, Object[] args, Locale locale) Try to resolve the resource.
Object	resolveResource(String key, Object[] args, Locale locale, Object defaultValue) Try to resolve the resource.
Object	resolveResource(String key, Object[] args, Object defaultValue) Try to resolve the resource.
Object	resolveResourceValue(String key, Locale locale) Resolve a resource given a key and a Locale.
protected Object[]	toObjectArray(List<?> args)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_KEY_BLANK

protected static final String ERROR_KEY_BLANK

See Also:

Constant Field Values

ERROR_LOCALE_NULL

protected static final String ERROR_LOCALE_NULL

See Also:

Constant Field Values

ERROR_ARGS_NULL

protected static final String ERROR_ARGS_NULL

See Also:

Constant Field Values

ERROR_RESOURCE_BLANK

protected static final String ERROR_RESOURCE_BLANK

See Also:

Constant Field Values

EMPTY_OBJECT_ARGS

protected static final Object[] EMPTY_OBJECT_ARGS

Constructor Detail

AbstractResourceResolver

public AbstractResourceResolver()

Method Detail

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       Locale locale)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

locale - Locale in which to lookup

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       Object[] args)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       Object[] args,
                                       @Nonnull
                                       Locale locale)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       List<?> args)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       List<?> args,
                                       @Nonnull
                                       Locale locale)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the default locale

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        Locale locale,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

locale - Locale in which to lookup

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the given locale

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        Object[] args,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the default locale

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        Object[] args,
                                        @Nonnull
                                        Locale locale,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the given locale

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        List<?> args,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the default locale

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        List<?> args,
                                        @Nonnull
                                        Locale locale,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the given locale

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       Map<String,Object> args)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{:key}" within a resource, but this might differ between implementations), or null if none.

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nonnull
public Object resolveResource(@Nonnull
                                       String key,
                                       @Nonnull
                                       Map<String,Object> args,
                                       @Nonnull
                                       Locale locale)
                                throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{:key}" within a resource, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        Map<String,Object> args,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{:key}" within a resource, but this might differ between implementations), or null if none.

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the default locale

resolveResource

@Nullable
public Object resolveResource(@Nonnull
                                        String key,
                                        @Nonnull
                                        Map<String,Object> args,
                                        @Nonnull
                                        Locale locale,
                                        @Nullable
                                        Object defaultValue)

Description copied from interface: ResourceResolver

Try to resolve the resource. Return default resource if no resource was found.

Specified by:

resolveResource in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

args - Arguments that will be filled in for params within the resource (params look like "{:key}" within a resource, but this might differ between implementations), or null if none.

locale - Locale in which to lookup

defaultValue - Message to return if the lookup fails

Returns:

The resolved resource at the given key for the given locale

resolveResourceValue

@Nonnull
public Object resolveResourceValue(@Nonnull
                                            String key,
                                            @Nonnull
                                            Locale locale)
                                     throws NoSuchResourceException

Description copied from interface: ResourceResolver

Resolve a resource given a key and a Locale.

This method should use the default Locale if the locale argument is null. The key argument may refer to another key if the resolved value results in a CharSequence that begins with "@[" and ends with "]". In this case the method will use the enclosed value as the next key to be resolved. For example, given the following key/value definitions

     some.key = Hello {0}
     other.key = @[some.key]
 

Evaluating the keys results in

    assert resolveResourceValue('some.key', Locale.default) == 'Hello {0}'
    assert resolveResourceValue('other.key', Locale.default) == 'Hello {0}'
 

Specified by:

resolveResourceValue in interface ResourceResolver

Parameters:

key - Key to lookup, such as 'sample.SampleModel.icon'

locale - Locale in which to lookup

Returns:

the resolved resource value at the given key for the given locale

Throws:

NoSuchResourceException - if no message is found

formatResource

@Nonnull
public String formatResource(@Nonnull
                                      String resource,
                                      @Nonnull
                                      List<?> args)

Description copied from interface: ResourceResolver

Formats the given resource using supplied args to substitute placeholders.

Specified by:

formatResource in interface ResourceResolver

Parameters:

resource - The resource following a predefined format.

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

Returns:

the formatted resource with all matching placeholders with their substituted values.

formatResource

@Nonnull
public String formatResource(@Nonnull
                                      String resource,
                                      @Nonnull
                                      Object[] args)

Description copied from interface: ResourceResolver

Formats the given resource using supplied args to substitute placeholders.

Specified by:

formatResource in interface ResourceResolver

Parameters:

resource - The resource following a predefined format.

args - Arguments that will be filled in for params within the resource (params look like "{0}" within a resource, but this might differ between implementations), or null if none.

Returns:

the formatted resource with all matching placeholders with their substituted values.

formatResource

@Nonnull
public String formatResource(@Nonnull
                                      String resource,
                                      @Nonnull
                                      Map<String,Object> args)

Description copied from interface: ResourceResolver

Formats the given resource using supplied args to substitute placeholders.

Specified by:

formatResource in interface ResourceResolver

Parameters:

resource - The resource following a predefined format.

args - Arguments that will be filled in for params within the resource (params look like "{:key}" within a resource, but this might differ between implementations), or null if none.

Returns:

the formatted resource with all matching placeholders with their substituted values.

doResolveResourceValue

@Nonnull
protected abstract Object doResolveResourceValue(@Nonnull
                                                          String key,
                                                          @Nonnull
                                                          Locale locale)
                                                   throws NoSuchResourceException

Throws:

NoSuchResourceException

evalResourceWithArguments

@Nullable
protected Object evalResourceWithArguments(@Nonnull
                                                     Object resource,
                                                     @Nonnull
                                                     Object[] args)

evalResourceWithArguments

@Nullable
protected Object evalResourceWithArguments(@Nonnull
                                                     Object resource,
                                                     @Nonnull
                                                     Map<String,Object> args)

toObjectArray

@Nonnull
protected Object[] toObjectArray(@Nonnull
                                          List<?> args)