DraweeConfig.java

/*
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */
package com.facebook.drawee.backends.pipeline;

import javax.annotation.Nullable;

import com.facebook.common.internal.ImmutableList;
import com.facebook.common.internal.Preconditions;
import com.facebook.common.internal.Supplier;
import com.facebook.common.internal.Suppliers;

import java.util.ArrayList;
import java.util.List;

/**
 * Drawee configuration.
 */
public class DraweeConfig {

  @Nullable
  private final ImmutableList<DrawableFactory> mCustomDrawableFactories;
  @Nullable
  private final PipelineDraweeControllerFactory mPipelineDraweeControllerFactory;
  private final Supplier<Boolean> mDebugOverlayEnabledSupplier;

  private DraweeConfig(Builder builder) {
    mCustomDrawableFactories = builder.mCustomDrawableFactories != null
        ? ImmutableList.copyOf(builder.mCustomDrawableFactories)
        : null;
    mDebugOverlayEnabledSupplier = builder.mDebugOverlayEnabledSupplier != null
        ? builder.mDebugOverlayEnabledSupplier
        : Suppliers.of(false);
    mPipelineDraweeControllerFactory = builder.mPipelineDraweeControllerFactory;
  }

  @Nullable
  public ImmutableList<DrawableFactory> getCustomDrawableFactories() {
    return mCustomDrawableFactories;
  }

  @Nullable
  public PipelineDraweeControllerFactory getPipelineDraweeControllerFactory() {
    return mPipelineDraweeControllerFactory;
  }

  public static Builder newBuilder() {
    return new Builder();
  }

  public Supplier<Boolean> getDebugOverlayEnabledSupplier() {
    return mDebugOverlayEnabledSupplier;
  }

  public static class Builder {

    private List<DrawableFactory> mCustomDrawableFactories;
    private Supplier<Boolean> mDebugOverlayEnabledSupplier;
    private PipelineDraweeControllerFactory mPipelineDraweeControllerFactory;

    /**
     * Add a custom drawable factory that will be used to create
     * Drawables for {@link com.facebook.imagepipeline.image.CloseableImage}s.
     *
     * @param factory the factory to use
     * @return the builder
     */
    public Builder addCustomDrawableFactory(DrawableFactory factory) {
      if (mCustomDrawableFactories == null) {
        mCustomDrawableFactories = new ArrayList<>();
      }
      mCustomDrawableFactories.add(factory);
      return this;
    }

    /**
     * Set whether a debug overlay that displays image information, like dimensions and size
     * should be drawn on top of a Drawee view.
     *
     * @param drawDebugOverlay <code>true</code> if the debug overlay should be drawn
     * @return the builder
     */
    public Builder setDrawDebugOverlay(boolean drawDebugOverlay) {
      return setDebugOverlayEnabledSupplier(Suppliers.of(drawDebugOverlay));
    }

    /**
     * Set whether a debug overlay that displays image information, like dimensions and size
     * should be drawn on top of a Drawee view.
     *
     * @param debugOverlayEnabledSupplier should return <code>true</code> if the debug overlay
     * should be drawn
     * @return the builder
     */
    public Builder setDebugOverlayEnabledSupplier(Supplier<Boolean> debugOverlayEnabledSupplier) {
      Preconditions.checkNotNull(debugOverlayEnabledSupplier);
      mDebugOverlayEnabledSupplier = debugOverlayEnabledSupplier;
      return this;
    }

    /**
     * Set a PipelineDraweeControllerFactory to be used instead of the default one.
     *
     * @param factory the PipelineDraweeControllerFactory to use
     * @return the builder
     */
    public Builder setPipelineDraweeControllerFactory(PipelineDraweeControllerFactory factory) {
      mPipelineDraweeControllerFactory = factory;
      return this;
    }

    public DraweeConfig build() {
      return new DraweeConfig(this);
    }
  }
}