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 * @version $Id: FunctorException.html 972421 2015-11-14 20:00:04Z tn $
025 */
026public class FunctorException extends RuntimeException {
027
028    /** Serialization version */
029    private static final long serialVersionUID = -4704772662059351193L;
030
031    /**
032     * Constructs a new <code>FunctorException</code> without specified
033     * detail message.
034     */
035    public FunctorException() {
036        super();
037    }
038
039    /**
040     * Constructs a new <code>FunctorException</code> with specified
041     * detail message.
042     *
043     * @param msg  the error message.
044     */
045    public FunctorException(final String msg) {
046        super(msg);
047    }
048
049    /**
050     * Constructs a new <code>FunctorException</code> with specified
051     * nested <code>Throwable</code> root cause.
052     *
053     * @param rootCause  the exception or error that caused this exception
054     *                   to be thrown.
055     */
056    public FunctorException(final Throwable rootCause) {
057        super(rootCause);
058    }
059
060    /**
061     * Constructs a new <code>FunctorException</code> with specified
062     * detail message and nested <code>Throwable</code> root cause.
063     *
064     * @param msg        the error message.
065     * @param rootCause  the exception or error that caused this exception
066     *                   to be thrown.
067     */
068    public FunctorException(final String msg, final Throwable rootCause) {
069        super(msg, rootCause);
070    }
071
072}