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;
018
019import java.util.function.Supplier;
020
021/**
022 * Defines a functor interface implemented by classes that create objects.
023 * <p>
024 * A {@code Factory} creates an object without using an input parameter.
025 * If an input parameter is required, then {@link Transformer} is more appropriate.
026 * </p>
027 * <p>
028 * Standard implementations of common factories are provided by
029 * {@link FactoryUtils}. These include factories that return a constant,
030 * a copy of a prototype or a new instance.
031 * </p>
032 *
033 * @param <T> the type that the factory creates
034 *
035 * @since 2.1
036 * @deprecated Use {@link Supplier}.
037 */
038@Deprecated
039public interface Factory<T> extends Supplier<T> {
040
041    /**
042     * Create a new object.
043     *
044     * @return a new object
045     * @throws FunctorException (runtime) if the factory cannot create an object
046     */
047    T create();
048
049    @Override
050    default T get() {
051        return create();
052    }
053
054}