/*
 * 
 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * The contents of this file are subject to the Sun Community Source
 * License v3.0/Jini Technology Specific Attachment v 1.0 (the
 * "License"). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 * http://wwws.sun.com/software/jini/licensing/SCSL3_JiniTSA1.html.
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Reference Code is Jini Technology Core Platform code, v2.0. The
 * Developer of the Reference Code is Sun Microsystems, Inc.
 * 
 * Contributor(s): Sun Microsystems, Inc.
 * 
 * The contents of this file comply with the Jini Technology Core
 * Platform Compatibility Kit, v2.0A.
 * 
 * Tester(s): Sun Microsystems, Inc.
 * 
 * Test Platform(s):
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Solaris(TM)SPARC/x86
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Linux (Intel x86)
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Windows (Intel Platform)
 * 
 */

package com.sun.jini.action;

import java.security.AccessController;
import java.security.PrivilegedAction;
import net.jini.security.Security;

/**
 * A convenience class for retrieving the <code>boolean</code> value
 * of a system property as a privileged action.
 *
 * <p>An instance of this class can be used as the argument of {@link
 * AccessController#doPrivileged(PrivilegedAction)
 * AccessController.doPrivileged} or {@link
 * Security#doPrivileged(PrivilegedAction) Security.doPrivileged}.
 *
 * <p>The following code retrieves the boolean value of the system
 * property named <code>"prop"</code> as a privileged action:
 *
 * <pre>
 * boolean b = ((Boolean) Security.doPrivileged(
 *                 new GetBooleanAction("prop"))).booleanValue();
 * </pre>
 *
 * @author	Sun Microsystems, Inc.
 * 
 * @see		PrivilegedAction
 * @see		AccessController
 * @see		Security
 * @since 2.0
 **/
public class GetBooleanAction implements PrivilegedAction {

    private final String theProp;

    /**
     * Constructor that takes the name of the system property whose
     * <code>boolean</code> value needs to be determined.
     *
     * @param	theProp the name of the system property
     **/
    public GetBooleanAction(String theProp) {
	this.theProp = theProp;
    }

    /**
     * Determines the <code>boolean</code> value of the system
     * property whose name was specified in the constructor.  The
     * value is returned in a <code>Boolean</code> object.
     *
     * <p>If the system property is defined to equal the string
     * <code>"true"</code> (case insensitive), then this method
     * returns a <code>Boolean</code> with the value
     * <code>true</code>.  Otherwise, this method returns a
     * <code>Boolean</code> with the value <code>false</code>.
     *
     * @return	a <code>Boolean</code> representing the value of
     * the system property
     **/
    public Object run() {
	return Boolean.getBoolean(theProp) ? Boolean.TRUE : Boolean.FALSE;
    }
}
