org.cp.elements.function.FunctionException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elements Show documentation

Java Simplified. Extensions and Useful Constructs for the Java Platform. Codeprimate Elements (a.k.a. cp-elements) is a Java library and micro-framework used to simplify the development of software applications written in Java. Elements packages several APIs into one library in order to address various application concerns and aspects of software design and development collectively and conveniently. Elements is a highly simple, yet robust and proven library built on solid OO principles, software design patterns and best practices to effectively solve common and reoccurring problems in software development. Write better Java!

The newest version!

/*
 * Copyright 2011-Present Author or Authors.
 *
 * 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.cp.elements.function;

import java.util.function.Function;

/**
 * Java {@link RuntimeException} used to generally classify {@link Throwable Throwables}
 * thrown from a Java {@link Function}.
 *
 * @author John Blum
 * @see java.lang.RuntimeException
 * @see java.util.function.Function
 * @since 2.0.0
 */
@SuppressWarnings("unused")
public class FunctionException extends RuntimeException {

  /**
   * Constructs a new {@link FunctionException} with no {@link String message}
   * and no probable {@link Throwable cause}.
   */
  public FunctionException() { }

  /**
   * Constructs a new {@link FunctionException} with the given {@link String message} describing the exception.
   *
   * @param message {@link String} containing a description of the exception.
   */
  public FunctionException(String message) {
    super(message);
  }

  /**
   * Constructs a new {@link FunctionException} with the given {@link Throwable cause}
   * as the reason this exception was thrown.
   *
   * @param cause {@link Throwable} used as the underlying reason this exception was thrown.
   */
  public FunctionException(Throwable cause) {
    super(cause);
  }

  /**
   * Constructs a new {@link FunctionException} with the given {@link String message} describing the exception
   * along with the given {@link Throwable cause} as the reason this exception was thrown.
   *
   * @param message {@link String} containing a description of the exception.
   * @param cause {@link Throwable} used as the underlying reason this exception was thrown.
   */
  public FunctionException(String message, Throwable cause) {
    super(message, cause);
  }
}