griffon.core.resources

Interface ResourceResolver

All Known Subinterfaces:

GroovyAwareResourceResolver

All Known Implementing Classes:

AbstractResourceResolver, CompositeResourceResolver, DefaultGroovyAwareResourceResolver, DefaultResourceResolver, ResourceResolverDecorator

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 java.lang.String	REF_KEY_END "]"
static java.lang.String	REF_KEY_START "@["

Method Summary

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

Field Detail

REF_KEY_START

static final java.lang.String REF_KEY_START

"@["

See Also:

Constant Field Values

REF_KEY_END

static final java.lang.String REF_KEY_END

"]"

See Also:

Constant Field Values

Method Detail

resolveResource

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

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
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)

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
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)

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

resolveResourceConverted

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

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

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

Since:

2.5.0

resolveResourceConverted

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

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

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

Since:

2.5.0

resolveResourceConverted

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

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

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

Since:

2.5.0

resolveResourceConverted

@Nonnull
<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

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

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

Since:

2.5.0

resolveResourceConverted

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

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

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

Since:

2.5.0

resolveResourceConverted

@Nonnull
<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

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

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

Since:

2.5.0

resolveResourceConverted

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

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.

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

Since:

2.5.0

resolveResourceConverted

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

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.

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

Since:

2.5.0

resolveResourceConverted

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

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.

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

Since:

2.5.0

resolveResourceConverted

@Nullable
<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)

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.

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

Since:

2.5.0

resolveResourceConverted

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

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.

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

Since:

2.5.0

resolveResourceConverted

@Nullable
<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)

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.

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

Since:

2.5.0

resolveResourceConverted

@Nonnull
<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

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

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

Since:

2.5.0

resolveResourceConverted

@Nonnull
<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

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

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

Since:

2.5.0

resolveResourceConverted

@Nullable
<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)

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.

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

Since:

2.5.0

resolveResourceConverted

@Nullable
<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)

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.

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

Since:

2.5.0

resolveResourceValue

@Nonnull
java.lang.Object resolveResourceValue(@Nonnull
                                               java.lang.String key,
                                               @Nonnull
                                               java.util.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
java.lang.String formatResource(@Nonnull
                                         java.lang.String resource,
                                         @Nonnull
                                         java.util.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
java.lang.String formatResource(@Nonnull
                                         java.lang.String resource,
                                         @Nonnull
                                         java.lang.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
java.lang.String formatResource(@Nonnull
                                         java.lang.String resource,
                                         @Nonnull
                                         java.util.Map<java.lang.String,java.lang.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.