| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1998-2006 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package sun.security.action; |
| 27 | |
| 28 | /** |
| 29 | * A convenience class for retrieving the boolean value of a system property |
| 30 | * as a privileged action. |
| 31 | * |
| 32 | * <p>An instance of this class can be used as the argument of |
| 33 | * <code>AccessController.doPrivileged</code>. |
| 34 | * |
| 35 | * <p>The following code retrieves the boolean value of the system |
| 36 | * property named <code>"prop"</code> as a privileged action: <p> |
| 37 | * |
| 38 | * <pre> |
| 39 | * boolean b = java.security.AccessController.doPrivileged |
| 40 | * (new GetBooleanAction("prop")).booleanValue(); |
| 41 | * </pre> |
| 42 | * |
| 43 | * @author Roland Schemers |
| 44 | * @see java.security.PrivilegedAction |
| 45 | * @see java.security.AccessController |
| 46 | * @since 1.2 |
| 47 | */ |
| 48 | |
| 49 | public class GetBooleanAction |
| 50 | implements java.security.PrivilegedAction<Boolean> { |
| 51 | private String theProp; |
| 52 | |
| 53 | /** |
| 54 | * Constructor that takes the name of the system property whose boolean |
| 55 | * value needs to be determined. |
| 56 | * |
| 57 | * @param theProp the name of the system property. |
| 58 | */ |
| 59 | public GetBooleanAction(String theProp) { |
| 60 | this.theProp = theProp; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Determines the boolean value of the system property whose name was |
| 65 | * specified in the constructor. |
| 66 | * |
| 67 | * @return the <code>Boolean</code> value of the system property. |
| 68 | */ |
| 69 | public Boolean run() { |
| 70 | return Boolean.getBoolean(theProp); |
| 71 | } |
| 72 | } |