org.conqat.lib.commons.factory.IFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.conqat.lib.commons.factory;

import java.util.function.Supplier;

import org.conqat.lib.commons.error.NeverThrownRuntimeException;

/**
 * Generic factory interface. In many cases you should use {@link Supplier} now, but this interface
 * also support to throw an exception.
 * 
 * @param 
 *            Type that gets created by the factory.
 * @param 
 *            Exception that can get thrown during execution of the factory method. If no exception
 *            is thrown, use {@link NeverThrownRuntimeException}.
 */
@FunctionalInterface
public interface IFactory {

	/** Factory method */
	T create() throws X;
}