com.bumptech.glide.load.model.UnitModelLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glide Show documentation
A fast and efficient image loading library for Android focused on smooth scrolling.
There is a newer version: 5.0.0-rc01
package com.bumptech.glide.load.model;

import androidx.annotation.NonNull;
import com.bumptech.glide.Priority;
import com.bumptech.glide.load.DataSource;
import com.bumptech.glide.load.Options;
import com.bumptech.glide.load.data.DataFetcher;
import com.bumptech.glide.signature.ObjectKey;

/**
 * A put of helper classes that performs no loading and instead always returns the given model as
 * the data to decode.
 *
 * @param  The type of model that will also be returned as decodable data.
 */
public class UnitModelLoader implements ModelLoader {
  @SuppressWarnings("deprecation")
  private static final UnitModelLoader INSTANCE = new UnitModelLoader<>();

  @SuppressWarnings("unchecked")
  public static  UnitModelLoader getInstance() {
    return (UnitModelLoader) INSTANCE;
  }

  /**
   * @deprecated Use {@link #getInstance()} instead.
   */
  // Need constructor to document deprecation, will be removed, when constructor is privatized.
  @SuppressWarnings({"PMD.UnnecessaryConstructor", "DeprecatedIsStillUsed"})
  @Deprecated
  public UnitModelLoader() {
    // Intentionally empty.
  }

  @Override
  public LoadData buildLoadData(
      @NonNull Model model, int width, int height, @NonNull Options options) {
    return new LoadData<>(new ObjectKey(model), new UnitFetcher<>(model));
  }

  @Override
  public boolean handles(@NonNull Model model) {
    return true;
  }

  private static class UnitFetcher implements DataFetcher {

    private final Model resource;

    UnitFetcher(Model resource) {
      this.resource = resource;
    }

    @Override
    public void loadData(
        @NonNull Priority priority, @NonNull DataCallback callback) {
      callback.onDataReady(resource);
    }

    @Override
    public void cleanup() {
      // Do nothing.
    }

    @Override
    public void cancel() {
      // Do nothing.
    }

    @NonNull
    @SuppressWarnings("unchecked")
    @Override
    public Class getDataClass() {
      return (Class) resource.getClass();
    }

    @NonNull
    @Override
    public DataSource getDataSource() {
      return DataSource.LOCAL;
    }
  }

  /**
   * Factory for producing {@link com.bumptech.glide.load.model.UnitModelLoader}s.
   *
   * @param  The type of model that will also be returned as decodable data.
   */
  // PMD.SingleMethodSingleton false positive: https://github.com/pmd/pmd/issues/816
  @SuppressWarnings("PMD.SingleMethodSingleton")
  public static class Factory implements ModelLoaderFactory {
    @SuppressWarnings("deprecation")
    private static final Factory FACTORY = new Factory<>();

    @SuppressWarnings("unchecked")
    public static  Factory getInstance() {
      return (Factory) FACTORY;
    }

    /**
     * @deprecated Use {@link #getInstance()} instead.
     */
    // Need constructor to document deprecation, will be removed, when constructor is privatized.
    @SuppressWarnings("PMD.UnnecessaryConstructor")
    @Deprecated
    public Factory() {
      // Intentionally empty.
    }

    @NonNull
    @Override
    public ModelLoader build(MultiModelLoaderFactory multiFactory) {
      return UnitModelLoader.getInstance();
    }

    @Override
    public void teardown() {
      // Do nothing.
    }
  }
}