001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  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.apache.commons.collections4;
018
019/**
020 * Runtime exception thrown from functors.
021 * If required, a root cause error can be wrapped within this one.
022 *
023 * @since 3.0
024 */
025public class FunctorException extends RuntimeException {
026
027    /** Serialization version */
028    private static final long serialVersionUID = -4704772662059351193L;
029
030    /**
031     * Constructs a new {@code FunctorException} without specified
032     * detail message.
033     */
034    public FunctorException() {
035    }
036
037    /**
038     * Constructs a new {@code FunctorException} with specified
039     * detail message.
040     *
041     * @param msg  the error message.
042     */
043    public FunctorException(final String msg) {
044        super(msg);
045    }
046
047    /**
048     * Constructs a new {@code FunctorException} with specified
049     * detail message and nested {@code Throwable} root cause.
050     *
051     * @param msg        the error message.
052     * @param rootCause  the exception or error that caused this exception
053     *                   to be thrown.
054     */
055    public FunctorException(final String msg, final Throwable rootCause) {
056        super(msg, rootCause);
057    }
058
059    /**
060     * Constructs a new {@code FunctorException} with specified
061     * nested {@code Throwable} root cause.
062     *
063     * @param rootCause  the exception or error that caused this exception
064     *                   to be thrown.
065     */
066    public FunctorException(final Throwable rootCause) {
067        super(rootCause);
068    }
069
070}