Package org.apache.commons.collections.functors

Class ConstantTransformer

  • All Implemented Interfaces:
    java.io.Serializable, Transformer
    @Deprecated(since="2021-04-30")
public class ConstantTransformer
extends java.lang.Object
implements Transformer, java.io.Serializable
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Transformer implementation that returns the same constant each time.

    No check is made that the object is immutable. In general, only immutable objects should use the constant factory. Mutable objects should use the prototype factory.

    Since:
    Commons Collections 3.0
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Transformer NULL_INSTANCE
      Deprecated.
      Returns null each time

    • Constructor Summary

      Constructors 
      Constructor Description
      ConstantTransformer​(java.lang.Object constantToReturn)
      Deprecated.
      Constructor that performs no validation.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object getConstant()
      Deprecated.
      Gets the constant.
      static Transformer getInstance​(java.lang.Object constantToReturn)
      Deprecated.
      Transformer method that performs validation.
      java.lang.Object transform​(java.lang.Object input)
      Deprecated.
      Transforms the input by ignoring it and returning the stored constant instead.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • NULL_INSTANCE

        public static final Transformer NULL_INSTANCE
        Deprecated.
        Returns null each time

    • Constructor Detail

      • ConstantTransformer

        public ConstantTransformer​(java.lang.Object constantToReturn)
        Deprecated.
        Constructor that performs no validation. Use getInstance if you want that.
        Parameters:
        constantToReturn - the constant to return each time

    • Method Detail

      • getInstance

        public static Transformer getInstance​(java.lang.Object constantToReturn)
        Deprecated.
        Transformer method that performs validation.
        Parameters:
        constantToReturn - the constant object to return each time in the factory
        Returns:
        the constant factory.

      • transform

        public java.lang.Object transform​(java.lang.Object input)
        Deprecated.
        Transforms the input by ignoring it and returning the stored constant instead.
        Specified by:
        transform in interface Transformer
        Parameters:
        input - the input object which is ignored
        Returns:
        the stored constant

      • getConstant

        public java.lang.Object getConstant()
        Deprecated.
        Gets the constant.
        Returns:
        the constant
        Since:
        Commons Collections 3.1