Class ResourceLocator


  • public final class ResourceLocator
    extends Object
    This class contains a collection of helper methods for finding JFace resources in bundles.
    Since:
    3.17
    Restriction:
    This class is not intended to be instantiated by clients.
    • Constructor Detail

      • ResourceLocator

        public ResourceLocator()
    • Method Detail

      • imageDescriptorFromBundle

        public static Optional<ImageDescriptor> imageDescriptorFromBundle​(String bundleSymbolicName,
                                                                          String imageFilePath)
        Returns a new Optional<ImageDescriptor> for an image file located within the specified bundle or Optional.empty().

        This is a convenience method that simply locates the image file in within the bundle. The path is relative to the root of the bundle, and takes into account files coming from bundle fragments. The path may include $arg$ elements. However, the path must not have a leading "." or path separator. Clients should use a path like "icons/mysample.png" rather than "./icons/mysample.png" or "/icons/mysample.png".

        Parameters:
        bundleSymbolicName - the Bundle symbolic name
        imageFilePath - the path of the image file in the given bundle, relative to the root of the bundle
        Returns:
        Optional<ImageDescriptor> or Optional.empty()
        See Also:
        ImageDescriptor.createFromURL(URL)
      • imageDescriptorFromBundle

        public static Optional<ImageDescriptor> imageDescriptorFromBundle​(Class<?> classFromBundle,
                                                                          String imageFilePath)
        Returns a new Optional<ImageDescriptor> for an image file located within the specified bundle or Optional.empty().

        This is a convenience method that simply locates the image file in within the bundle. The path is relative to the root of the bundle, and takes into account files coming from bundle fragments. The path may include $arg$ elements. However, the path must not have a leading "." or path separator. Clients should use a path like "icons/mysample.png" rather than "./icons/mysample.png" or "/icons/mysample.png".

        Parameters:
        classFromBundle - A class defined by a bundle class loader.
        imageFilePath - the path of the image file in the given bundle, relative to the root of the bundle
        Returns:
        Optional<ImageDescriptor> or Optional.empty()
        See Also:
        ImageDescriptor.createFromURL(URL)