1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.collections4;
19
20 import java.util.function.Supplier;
21
22 /**
23 * Defines a functor interface implemented by classes that create objects.
24 * <p>
25 * A {@code Factory} creates an object without using an input parameter. If an input parameter is required, then {@link Transformer} is more appropriate.
26 * </p>
27 * <p>
28 * Standard implementations of common factories are provided by {@link FactoryUtils}. These include factories that return a constant, a copy of a prototype or a
29 * new instance.
30 * </p>
31 *
32 * @param <T> The type of results supplied by this supplier.
33 * @since 2.1 This will be deprecated in 5.0 in favor of {@link Supplier}.
34 */
35 //@Deprecated
36 public interface Factory<T> extends Supplier<T> {
37
38 /**
39 * Create a new object.
40 *
41 * @return A new object
42 * @throws FunctorException (runtime) if the factory cannot create an object.
43 */
44 T create();
45
46 @Override
47 default T get() {
48 return create();
49 }
50 }