com.helger.commons.functional.IThrowingSupplier Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2014-2023 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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 com.helger.commons.functional;

/**
 * Represents a supplier of results that may throw an Exception.
 * 
 * There is no requirement that a new or distinct result be returned each time
 * the supplier is invoked.
 * 
 * This is a functional interface whose functional method is {@link #get()}.
 *
 * @param 
 *        the type of results supplied by this supplier
 * @param 
 *        exception type
 * @since 8.3.1
 */
@FunctionalInterface
public interface IThrowingSupplier 
{
  /**
   * Gets a result.
   *
   * @return a result
   * @throws EXTYPE
   *         In case it is needed
   */
  T get () throws EXTYPE;
}