⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.functors

Class ConstantFactory

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

All Implemented Interfaces:
Factory, Serializable


public class ConstantFactory
extends java.lang.Object
implements Factory, Serializable

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
Author:
Stephen Colebourne

Field Summary

static Factory

NULL_INSTANCE

Returns null each time

Constructor Summary

ConstantFactory(Object constantToReturn)

Constructor that performs no validation.

Method Summary

Object

create()

Always return constant

static Factory

getInstance(Object constantToReturn)

Factory method that performs validation.

Field Details

NULL_INSTANCE

public static final Factory NULL_INSTANCE

Returns null each time

Constructor Details

ConstantFactory

public ConstantFactory(Object constantToReturn)

Constructor that performs no validation. Use getInstance if you want that.

Parameters:
constantToReturn - the constant to return each time

Method Details

create

public Object create()

Always return constant


getInstance

public static Factory getInstance(Object constantToReturn)

Factory method that performs validation.

Parameters:
constantToReturn - the constant object to return each time in the factory
Returns:
the constant factory.