org.eclipse.emf.common.util

Interface ResourceLocator

All Known Implementing Classes:

CommonPlugin, CommonPlugin.Implementation, DelegatingResourceLocator, EMFPlugin, EMFPlugin.EclipsePlugin

public interface ResourceLocator

A locator of Java resources.

Method Summary

Modifier and Type	Method and Description
java.net.URL	getBaseURL() Returns the URL from which all resources are based.
java.lang.Object	getImage(java.lang.String key) Returns the description that can be used to create the image resource associated with the key.
java.lang.String	getString(java.lang.String key) Returns the string resource associated with the key.
java.lang.String	getString(java.lang.String key, boolean translate) Returns the string resource associated with the key.
java.lang.String	getString(java.lang.String key, java.lang.Object[] substitutions) Returns a string resource associated with the key, and performs substitutions.
java.lang.String	getString(java.lang.String key, java.lang.Object[] substitutions, boolean translate) Returns a string resource associated with the key, and performs substitutions.

Method Detail

getBaseURL

java.net.URL getBaseURL()

Returns the URL from which all resources are based.

Returns:

the URL from which all resources are based.

getImage

java.lang.Object getImage(java.lang.String key)

Returns the description that can be used to create the image resource associated with the key. The description will typically be in the form of a URL to the image data. Creation of an actual image depends on the GUI environment; within Eclipse, org.eclipse.emf.edit.ui.provider.ExtendedImageRegistry can be used.

Parameters:

key - the key of the image resource.

Returns:

the description on the image resource.

getString

java.lang.String getString(java.lang.String key)

Returns the string resource associated with the key.

Parameters:

key - the key of the string resource.

Returns:

the string resource associated with the key.

getString

java.lang.String getString(java.lang.String key,
                           boolean translate)

Returns the string resource associated with the key.

Parameters:

key - the key of the string resource.

translate - whether the result is to be translated to the current locale.

Returns:

the string resource associated with the key.

getString

java.lang.String getString(java.lang.String key,
                           java.lang.Object[] substitutions)

Returns a string resource associated with the key, and performs substitutions.

Parameters:

key - the key of the string.

substitutions - the message substitutions.

Returns:

a string resource associated with the key.

See Also:

getString(String), MessageFormat.format(String, Object[])

getString

java.lang.String getString(java.lang.String key,
                           java.lang.Object[] substitutions,
                           boolean translate)

Returns a string resource associated with the key, and performs substitutions.

Parameters:

key - the key of the string.

substitutions - the message substitutions.

translate - whether the result is to be translated to the current locale.

Returns:

a string resource associated with the key.

See Also:

getString(String), MessageFormat.format(String, Object[])