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 java.lang.Object
implements ResourceResolver

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object[]	EMPTY_OBJECT_ARGS
protected static java.lang.String	ERROR_ARGS_NULL
protected static java.lang.String	ERROR_KEY_BLANK
protected static java.lang.String	ERROR_LOCALE_NULL
protected static java.lang.String	ERROR_RESOURCE_NULL

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 <T> T	convertValue(java.lang.Object value, java.lang.Class<T> type)
protected abstract java.lang.Object	doResolveResourceValue(java.lang.String key, java.util.Locale locale)
protected java.lang.Object	evalResourceWithArguments(java.lang.Object resource, java.util.Map<java.lang.String,java.lang.Object> args)
protected java.lang.Object	evalResourceWithArguments(java.lang.Object resource, java.lang.Object[] args)
java.lang.String	formatResource(java.lang.String resource, java.util.List<?> args) Formats the given resource using supplied args to substitute placeholders.
java.lang.String	formatResource(java.lang.String resource, java.util.Map<java.lang.String,java.lang.Object> args) Formats the given resource using supplied args to substitute placeholders.
java.lang.String	formatResource(java.lang.String resource, java.lang.Object[] args) Formats the given resource using supplied args to substitute placeholders.
java.lang.Object	resolveResource(java.lang.String key) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.List<?> args) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.List<?> args, java.util.Locale locale) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.List<?> args, java.util.Locale locale, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.List<?> args, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.Locale locale) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.Locale locale, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, java.util.Locale locale) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, java.util.Locale locale, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.lang.Object[] args) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.lang.Object[] args, java.util.Locale locale) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.lang.Object[] args, java.util.Locale locale, java.lang.Object defaultValue) Try to resolve the resource.
java.lang.Object	resolveResource(java.lang.String key, java.lang.Object[] args, java.lang.Object defaultValue) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.List<?> args, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.List<?> args, java.util.Locale locale, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.List<?> args, java.util.Locale locale, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.List<?> args, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.Locale locale, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.Locale locale, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, java.util.Locale locale, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, java.util.Locale locale, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> args, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.lang.Object[] args, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.lang.Object[] args, java.util.Locale locale, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.lang.Object[] args, java.util.Locale locale, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, java.lang.Object[] args, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
<T> T	resolveResourceConverted(java.lang.String key, T defaultValue, java.lang.Class<T> type) Try to resolve the resource.
java.lang.Object	resolveResourceValue(java.lang.String key, java.util.Locale locale) Resolve a resource given a key and a Locale.
protected java.lang.Object[]	toObjectArray(java.util.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 java.lang.String ERROR_KEY_BLANK

See Also:

Constant Field Values

ERROR_LOCALE_NULL

protected static final java.lang.String ERROR_LOCALE_NULL

See Also:

Constant Field Values

ERROR_ARGS_NULL

protected static final java.lang.String ERROR_ARGS_NULL

See Also:

Constant Field Values

ERROR_RESOURCE_NULL

protected static final java.lang.String ERROR_RESOURCE_NULL

See Also:

Constant Field Values

EMPTY_OBJECT_ARGS

protected static final java.lang.Object[] EMPTY_OBJECT_ARGS

Constructor Detail

AbstractResourceResolver

public AbstractResourceResolver()

Method Detail

resolveResource

@Nonnull
public java.lang.Object resolveResource(@Nonnull
                                                 java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.util.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.lang.Object[] args,
                                                 @Nonnull
                                                 java.util.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.util.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.util.List<?> args,
                                                 @Nonnull
                                                 java.util.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.util.Locale locale,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.lang.Object[] args,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.lang.Object[] args,
                                                  @Nonnull
                                                  java.util.Locale locale,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.util.List<?> args,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.util.List<?> args,
                                                  @Nonnull
                                                  java.util.Locale locale,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.util.Map<java.lang.String,java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                 java.lang.String key,
                                                 @Nonnull
                                                 java.util.Map<java.lang.String,java.lang.Object> args,
                                                 @Nonnull
                                                 java.util.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.util.Map<java.lang.String,java.lang.Object> args,
                                                  @Nullable
                                                  java.lang.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 java.lang.Object resolveResource(@Nonnull
                                                  java.lang.String key,
                                                  @Nonnull
                                                  java.util.Map<java.lang.String,java.lang.Object> args,
                                                  @Nonnull
                                                  java.util.Locale locale,
                                                  @Nullable
                                                  java.lang.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

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.util.List<?> args,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.util.List<?> args,
                                                @Nonnull
                                                java.util.Locale locale,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.util.List<?> args,
                                               @Nonnull
                                               java.util.Locale locale,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.util.List<?> args,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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.

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.util.Map<java.lang.String,java.lang.Object> args,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.util.Map<java.lang.String,java.lang.Object> args,
                                                @Nonnull
                                                java.util.Locale locale,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.util.Map<java.lang.String,java.lang.Object> args,
                                               @Nonnull
                                               java.util.Locale locale,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.util.Map<java.lang.String,java.lang.Object> args,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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.

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.lang.Object[] args,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.lang.Object[] args,
                                                @Nonnull
                                                java.util.Locale locale,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.lang.Object[] args,
                                               @Nonnull
                                               java.util.Locale locale,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.lang.Object[] args,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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.

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted in interface ResourceResolver

Parameters:

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

defaultValue - Message to return if the lookup fails

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

resolveResourceConverted

@Nullable
public <T> T resolveResourceConverted(@Nonnull
                                                java.lang.String key,
                                                @Nonnull
                                                java.util.Locale locale,
                                                @Nullable
                                                T defaultValue,
                                                @Nonnull
                                                java.lang.Class<T> type)

Description copied from interface: ResourceResolver

Try to resolve the resource. Returns default value if no resource was found. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted 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

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.util.Locale locale,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted in interface ResourceResolver

Parameters:

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

locale - Locale in which to lookup

type - the type to be returned

Returns:

The resolved resource at the given key for the given locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceConverted

@Nonnull
public <T> T resolveResourceConverted(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.lang.Class<T> type)
                                        throws NoSuchResourceException

Description copied from interface: ResourceResolver

Try to resolve the resource. The value is converted to type T if found using a PropertyEditor.

Specified by:

resolveResourceConverted in interface ResourceResolver

Parameters:

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

type - the type to be returned

Returns:

The resolved resource at the given key for the default locale

Throws:

NoSuchResourceException - if no resource is found

resolveResourceValue

@Nonnull
public java.lang.Object resolveResourceValue(@Nonnull
                                                      java.lang.String key,
                                                      @Nonnull
                                                      java.util.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 java.lang.String formatResource(@Nonnull
                                                java.lang.String resource,
                                                @Nonnull
                                                java.util.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 java.lang.String formatResource(@Nonnull
                                                java.lang.String resource,
                                                @Nonnull
                                                java.lang.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 java.lang.String formatResource(@Nonnull
                                                java.lang.String resource,
                                                @Nonnull
                                                java.util.Map<java.lang.String,java.lang.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 java.lang.Object doResolveResourceValue(@Nonnull
                                                                    java.lang.String key,
                                                                    @Nonnull
                                                                    java.util.Locale locale)
                                                             throws NoSuchResourceException

Throws:

NoSuchResourceException

evalResourceWithArguments

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

evalResourceWithArguments

@Nullable
protected java.lang.Object evalResourceWithArguments(@Nonnull
                                                               java.lang.Object resource,
                                                               @Nonnull
                                                               java.util.Map<java.lang.String,java.lang.Object> args)

toObjectArray

@Nonnull
protected java.lang.Object[] toObjectArray(@Nonnull
                                                    java.util.List<?> args)

convertValue

protected <T> T convertValue(@Nullable
                             java.lang.Object value,
                             @Nonnull
                             java.lang.Class<T> type)