001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015-2016 ForgeRock AS.
015 */
016package org.forgerock.util.promise;
017
018/**
019 * The {@code NeverThrowsException} class is an uninstantiable placeholder
020 * exception which should be used for indicating that a {@link org.forgerock.util.Function} or
021 * {@link org.forgerock.util.AsyncFunction} never throws an exception (i.e. the function cannot
022 * fail).
023 */
024public final class NeverThrowsException extends RuntimeException {
025    /**
026     * Serialization ID.
027     */
028    private static final long serialVersionUID = 2879912363036916597L;
029
030    // Prevent instantiation.
031    private NeverThrowsException() {
032        throw new IllegalStateException();
033    }
034}