ConstantFactory (The Adobe Experience Manager SDK 2024.06.16647.20240607T103723Z-240500)

java.lang.Object
- org.apache.commons.collections.functors.ConstantFactory

All Implemented Interfaces:

java.io.Serializable, Factory
```
@Deprecated(since="2021-04-30")
public class ConstantFactory
extends java.lang.Object
implements Factory, java.io.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.

Factory 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 Factory NULL_INSTANCE
Deprecated.

Returns null each time

Constructor Summary

Constructors
Constructor Description

ConstantFactory(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`	`create()`	Deprecated. Always return constant.
`java.lang.Object`	`getConstant()`	Deprecated. Gets the constant.
`static Factory`	`getInstance(java.lang.Object constantToReturn)`	Deprecated. Factory method that performs validation.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NULL_INSTANCE
```
public static final Factory NULL_INSTANCE
```
    Deprecated.
    
    Returns null each time
- Constructor Detail
  - ConstantFactory
```
public ConstantFactory(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 Factory getInstance(java.lang.Object constantToReturn)
```
    Deprecated.
    
    Factory method that performs validation.
    
    Parameters:
    
    constantToReturn - the constant object to return each time in the factory
    
    Returns:
    
    the constant factory.
  - create
```
public java.lang.Object create()
```
    Deprecated.
    
    Always return constant.
    
    Specified by:
    
    create in interface Factory
    
    Returns:
    
    the stored constant value
  - getConstant
```
public java.lang.Object getConstant()
```
    Deprecated.
    
    Gets the constant.
    
    Returns:
    
    the constant
    
    Since:
    
    Commons Collections 3.1