griffon.core.resources

Interface ResourceResolver

All Known Implementing Classes:

AbstractResourceResolver, CompositeResourceResolver, DefaultResourceResolver

public interface ResourceResolver

Interface for resolving resources, with support for the parameterization and internationalization of such resources.

Since:

2.0.0

Author:

Andres Almiray, Alexander Klein

Field Summary

Fields

Modifier and Type	Field and Description
static String	REF_KEY_END "]"
static String	REF_KEY_START "@["

Method Summary

Methods

Modifier and Type	Method and Description
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.

Field Detail

REF_KEY_START

static final String REF_KEY_START

"@["

See Also:

Constant Field Values

REF_KEY_END

static final String REF_KEY_END

"]"

See Also:

Constant Field Values

Method Detail

resolveResource

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

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             Locale locale)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             Object[] args)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             Object[] args,
                             @Nonnull
                             Locale locale)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             List<?> args)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             List<?> args,
                             @Nonnull
                             Locale locale)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                              String key,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              Locale locale,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              Object[] args,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              Object[] args,
                              @Nonnull
                              Locale locale,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              List<?> args,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              List<?> args,
                              @Nonnull
                              Locale locale,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             Map<String,Object> args)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                             String key,
                             @Nonnull
                             Map<String,Object> args,
                             @Nonnull
                             Locale locale)
                       throws NoSuchResourceException

Try to resolve the resource.

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              Map<String,Object> args,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResource(@Nonnull
                              String key,
                              @Nonnull
                              Map<String,Object> args,
                              @Nonnull
                              Locale locale,
                              @Nullable
                              Object defaultValue)

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

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
Object resolveResourceValue(@Nonnull
                                  String key,
                                  @Nonnull
                                  Locale locale)
                            throws NoSuchResourceException

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}'
 

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
String formatResource(@Nonnull
                            String resource,
                            @Nonnull
                            List<?> args)

Formats the given resource using supplied args to substitute placeholders.

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
String formatResource(@Nonnull
                            String resource,
                            @Nonnull
                            Object[] args)

Formats the given resource using supplied args to substitute placeholders.

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
String formatResource(@Nonnull
                            String resource,
                            @Nonnull
                            Map<String,Object> args)

Formats the given resource using supplied args to substitute placeholders.

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.