/*

 * 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 sun.security.action;

/**

 * A convenience class for retrieving the boolean value of a system property

 * as a privileged action.

 *

 * <p>An instance of this class can be used as the argument of

 * <code>AccessController.doPrivileged</code>.

 *

 * <p>The following code retrieves the boolean value of the system

 * property named <code>"prop"</code> as a privileged action:

 *

 * <pre>

 * boolean b = java.security.AccessController.doPrivileged

 *              (new GetBooleanAction("prop")).booleanValue();

 * </pre>

 *

 * @author Roland Schemers

 * @see java.security.PrivilegedAction

 * @see java.security.AccessController

 * @since 1.2

 */

public class GetBooleanAction

        implements java.security.PrivilegedAction<Boolean> {

    private String theProp;

    /**

     * Constructor that takes the name of the system property whose boolean

     * value needs to be determined.

     *

     * @param theProp the name of the system property.

     */

    public GetBooleanAction(String theProp) {

        this.theProp = theProp;

    }

    /**

     * Determines the boolean value of the system property whose name was

     * specified in the constructor.

     *

     * @return the <code>Boolean</code> value of the system property.

     */

    public Boolean run() {

        return Boolean.getBoolean(theProp);

    }

}