Package org.apache.commons.collections.functors

Class ConstantTransformer

java.lang.Object
org.apache.commons.collections.functors.ConstantTransformer
All Implemented Interfaces:
Serializable, Transformer
@Deprecated(since="2021-04-30") public class ConstantTransformer extends Object implements Transformer, Serializable
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
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:

  • Field Details

    • NULL_INSTANCE

      public static final Transformer NULL_INSTANCE
      Deprecated.
      Returns null each time

  • Constructor Details

    • ConstantTransformer

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

  • Method Details

    • getInstance

      public static Transformer getInstance(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 Object transform(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 Object getConstant()
      Deprecated.
      Gets the constant.
      Returns:
      the constant
      Since:
      Commons Collections 3.1