/*

 * Copyright (c) 1998, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.security;

/**

 * A computation to be performed with privileges enabled, that throws one or

 * more checked exceptions.  The computation is performed by invoking

 * {@code AccessController.doPrivileged} on the

 * {@code PrivilegedExceptionAction} object.  This interface is

 * used only for computations that throw checked exceptions;

 * computations that do not throw

 * checked exceptions should use {@code PrivilegedAction} instead.

 *

 * @since 1.2

 * @see AccessController

 * @see AccessController#doPrivileged(PrivilegedExceptionAction)

 * @see AccessController#doPrivileged(PrivilegedExceptionAction,

 *                                              AccessControlContext)

 * @see PrivilegedAction

 */

@FunctionalInterface

public interface PrivilegedExceptionAction<T> {

    /**

     * Performs the computation.  This method will be called by

     * {@code AccessController.doPrivileged} after enabling privileges.

     *

     * @return a class-dependent value that may represent the results of the

     *         computation.  Each class that implements

     *         {@code PrivilegedExceptionAction} should document what

     *         (if anything) this value represents.

     * @throws Exception an exceptional condition has occurred.  Each class

     *         that implements {@code PrivilegedExceptionAction} should

     *         document the exceptions that its run method can throw.

     * @see AccessController#doPrivileged(PrivilegedExceptionAction)

     * @see AccessController#doPrivileged(PrivilegedExceptionAction,AccessControlContext)

     */

    T run() throws Exception;

}