org.apache.commons.collections.functors

Class ConstantFactory

public class ConstantFactory extends 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

Version: $Revision: 348444 $ $Date: 2005-11-23 14:06:56 +0000 (Wed, 23 Nov 2005) $

Author: Stephen Colebourne

Field Summary
static FactoryNULL_INSTANCE
Returns null each time
Constructor Summary
ConstantFactory(Object constantToReturn)
Constructor that performs no validation.
Method Summary
Objectcreate()
Always return constant.
ObjectgetConstant()
Gets the constant.
static FactorygetInstance(Object constantToReturn)
Factory method that performs validation.

Field Detail

NULL_INSTANCE

public static final Factory NULL_INSTANCE
Returns null each time

Constructor Detail

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 Detail

create

public Object create()
Always return constant.

Returns: the stored constant value

getConstant

public Object getConstant()
Gets the constant.

Returns: the constant

Since: Commons Collections 3.1

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.

Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.