    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.collections4.functors;
    018
    019import java.io.Serializable;
    020
    021import org.apache.commons.collections4.Factory;
    022
    023/**
    024 * Factory implementation that returns the same constant each time.
    025 * <p>
    026 * No check is made that the object is immutable. In general, only immutable
    027 * objects should use the constant factory. Mutable objects should
    028 * use the prototype factory.
    029 *
    030 * @since 3.0
    031 */
    032public class ConstantFactory<T> implements Factory<T>, Serializable {
    033
    034    /** Serial version UID */
    035    private static final long serialVersionUID = -3520677225766901240L;
    036
    037    /** Returns null each time */
    038    @SuppressWarnings("rawtypes") // The null factory works for all object types
    039    public static final Factory NULL_INSTANCE = new ConstantFactory<>(null);
    040
    041    /** The closures to call in turn */
    042    private final T iConstant;
    043
    044    /**
    045     * Factory method that performs validation.
    046     *
    047     * @param <T>  the type of the constant
    048     * @param constantToReturn  the constant object to return each time in the factory
    049     * @return the <code>constant</code> factory.
    050     */
    051    @SuppressWarnings("unchecked") // The null factory works for all object types
    052    public static <T> Factory<T> constantFactory(final T constantToReturn) {
    053        if (constantToReturn == null) {
    054            return NULL_INSTANCE;
    055        }
    056        return new ConstantFactory<>(constantToReturn);
    057    }
    058
    059    /**
    060     * Constructor that performs no validation.
    061     * Use <code>constantFactory</code> if you want that.
    062     *
    063     * @param constantToReturn  the constant to return each time
    064     */
    065    public ConstantFactory(final T constantToReturn) {
    066        super();
    067        iConstant = constantToReturn;
    068    }
    069
    070    /**
    071     * Always return constant.
    072     *
    073     * @return the stored constant value
    074     */
    075    @Override
    076    public T create() {
    077        return iConstant;
    078    }
    079
    080    /**
    081     * Gets the constant.
    082     *
    083     * @return the constant
    084     * @since 3.1
    085     */
    086    public T getConstant() {
    087        return iConstant;
    088    }
    089
    090}