Class ResourceLoader<Data>

  • Type Parameters:
    Data - The type of data that will be loaded for the given android resource.
    All Implemented Interfaces:
    ModelLoader<java.lang.Integer,​Data>

    public class ResourceLoader<Data>
    extends java.lang.Object
    implements ModelLoader<java.lang.Integer,​Data>
    A model loader for handling Android resource files. Model must be an Android resource id in the package of the given context.
    • Constructor Detail

      • ResourceLoader

        public ResourceLoader​(android.content.res.Resources resources,
                              ModelLoader<android.net.Uri,​Data> uriLoader)
    • Method Detail

      • buildLoadData

        public ModelLoader.LoadData<Data> buildLoadData​(@NonNull
                                                        java.lang.Integer model,
                                                        int width,
                                                        int height,
                                                        @NonNull
                                                        Options options)
        Description copied from interface: ModelLoader
        Returns a ModelLoader.LoadData containing a DataFetcher required to decode the resource represented by this model, as well as a set of Keys that identify the data loaded by the DataFetcher as well as an optional list of alternate keys from which equivalent data can be loaded. The DataFetcher will not be used if the resource is already cached.

        Note - If no valid data fetcher can be returned (for example if a model has a null URL), then it is acceptable to return a null data fetcher from this method.

        Specified by:
        buildLoadData in interface ModelLoader<java.lang.Integer,​Data>
        Parameters:
        model - The model representing the resource.
        width - The width in pixels of the view or target the resource will be loaded into, or Target.SIZE_ORIGINAL to indicate that the resource should be loaded at its original width.
        height - The height in pixels of the view or target the resource will be loaded into, or Target.SIZE_ORIGINAL to indicate that the resource should be loaded at its original height.
      • handles

        public boolean handles​(@NonNull
                               java.lang.Integer model)
        Description copied from interface: ModelLoader
        Returns true if the given model is a of a recognized type that this loader can probably load.

        For example, you may want multiple Uri to InputStream loaders. One might handle media store Uris, another might handle asset Uris, and a third might handle file Uris etc.

        This method is generally expected to do no I/O and complete quickly, so best effort results are acceptable. ModelLoaders that return true from this method may return null from ModelLoader.buildLoadData(Object, int, int, Options)

        Specified by:
        handles in interface ModelLoader<java.lang.Integer,​Data>