Class NullDecoder<T,Z>

  • Type Parameters:
    T - The type of the data that will be ignored by this class.
    Z - The type of the decoded resource that will always be null.
    All Implemented Interfaces:
    ResourceDecoder<T,Z>


    public class NullDecoder<T,Z>
    extends Object
    implements ResourceDecoder<T,Z>
    A simple ResourceDecoder that always returns null.
    • Constructor Summary

      Constructors

      Constructor and Description
      NullDecoder()
       
    • Method Summary

      Modifier and Type Method and Description
      Resource<Z> decode(T source, int width, int height)
      Returns a decoded resource from the given data or null if no resource could be decoded.
      static <T,Z> NullDecoder<T,Z> get()
      Returns an instance of the NullDecoder for the given types.
      String getId()
      Returns an ID identifying any transformation this decoder may apply to the given data that will be mixed in to the cache key.
    • Constructor Detail

      • NullDecoder

        public NullDecoder()
    • Method Detail

      • get

        public static <T,Z> NullDecoder<T,Z> get()
        Returns an instance of the NullDecoder for the given types.
        Type Parameters:
        T - The data type.
        Z - The resource type.
      • decode

        public Resource<Z> decode(T source,
                                  int width,
                                  int height)
        Description copied from interface: ResourceDecoder
        Returns a decoded resource from the given data or null if no resource could be decoded.

        The source is managed by the caller, there's no need to close it. The returned Resource will be released when the engine sees fit.

        Note - The width and height arguments are hints only, there is no requirement that the decoded resource exactly match the given dimensions. A typical use case would be to use the target dimensions to determine how much to downsample Bitmaps by to avoid overly large allocations.

        Specified by:
        decode in interface  ResourceDecoder<T,Z>
        Parameters:
        source - The data the resource should be decoded from.
        width - The ideal width in pixels of the decoded resource, or Target.SIZE_ORIGINAL to indicate the original resource width.
        height - The ideal height in pixels of the decoded resource, or Target.SIZE_ORIGINAL to indicate the original resource height.
      • getId

        public String getId()
        Description copied from interface: ResourceDecoder
        Returns an ID identifying any transformation this decoder may apply to the given data that will be mixed in to the cache key.

        If the decoder does not transform the data in a way that significantly affects the cached result (ie performs no downsampling) an empty string is an appropriate id.