001/* 002 * Configurate 003 * Copyright (C) zml and Configurate contributors 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * 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.spongepowered.configurate.util; 018 019import java.util.function.Consumer; 020 021/** 022 * A functional interface similar to Consumer, except allowing contained methods 023 * to throw exceptions. 024 * 025 * @param <V> the value accepted 026 * @param <E> the exception type thrown 027 * @since 4.0.0 028 */ 029@FunctionalInterface 030public interface CheckedConsumer<V, E extends Throwable> { 031 032 /** 033 * Accept a value. 034 * 035 * @param value value excepted 036 * @throws E exception thrown, described in detail at the use site. 037 * @since 4.0.0 038 */ 039 void accept(V value) throws E; 040 041 /** 042 * Create an instance from an ordinary consumer. 043 * 044 * @param consumer the consumer to convert 045 * @param <V> the type returned by the consumer 046 * @return a function that executes the provided consumer 047 * @since 4.0.0 048 */ 049 static <V> CheckedConsumer<V, RuntimeException> from(Consumer<V> consumer) { 050 return consumer::accept; 051 } 052 053}