<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--NewPage-->
<html>
<head>
<!-- Generated by javadoc on Wed Jul 28 01:21:15 GMT 1999 -->
<title>
  Class java.lang.Boolean
</title>
</head>
<body>
<a name="_top_"></a>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.lang.html">This Package</a>  <a href="Package-java.lang.html">Previous</a>  <a href="java.lang.Byte.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
<hr>
<h1>
  Class java.lang.Boolean
</h1>
<pre>
<a href="java.lang.Object.html#_top_">java.lang.Object</a>
   |
   +----java.lang.Boolean
</pre>
<hr>
<dl>
  <dt> public final class <b>Boolean</b>
  <dt> extends <a href="java.lang.Object.html#_top_">Object</a>
  <dt> implements <a href="java.io.Serializable.html#_top_">Serializable</a>
</dl>
The Boolean class wraps a value of the primitive type 
 <code>boolean</code> in an object. An object of type 
 <code>Boolean</code> contains a single field whose type is 
 <code>boolean</code>. 
 <p>
 In addition, this class provides many methods for 
 converting a <code>boolean</code> to a <code>String</code> and a 
 <code>String</code> to a <code>boolean</code>, as well as other 
 constants and methods useful when dealing with a 
 <code>boolean</code>.
<p>
<hr>
<a name="index"></a>
<h2>
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
</h2>
<dl>
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#FALSE"><b>FALSE</b></a>
  <dd> 
 The <code>Boolean</code> object corresponding to the primitive 
 value <code>false</code>.
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#TRUE"><b>TRUE</b></a>
  <dd> 
 The <code>Boolean</code> object corresponding to the primitive 
 value <code>true</code>.
  <dt> <img src="images/blue-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#TYPE"><b>TYPE</b></a>
  <dd>  The Class object representing the primitive type boolean.
</dl>
<h2>
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
</h2>
<dl>
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#Boolean(boolean)"><b>Boolean</b></a>(boolean)
  <dd>  Allocates a <code>Boolean</code> object representing the 
 <code>value</code> argument.
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#Boolean(java.lang.String)"><b>Boolean</b></a>(String)
  <dd>  Allocates a <code>Boolean</code> object representing the value 
 <code>true</code> if the string argument is not <code>null</code> 
 and is equal, ignoring case, to the string <code>"true"</code>.
</dl>
<h2>
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
</h2>
<dl>
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#booleanValue()"><b>booleanValue</b></a>()
  <dd>  Returns the value of this Boolean object as a boolean.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#equals(java.lang.Object)"><b>equals</b></a>(Object)
  <dd>  Returns <code>true</code> if and only if the argument is not 
 <code>null</code> and is a <code>Boolean </code>object that 
 contains the same <code>boolean</code> value as this object.
  <dt> <img src="images/green-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getBoolean(java.lang.String)"><b>getBoolean</b></a>(String)
  <dd>  Returns is <code>true</code> if and only if the system property 
 named by the argument exists and is equal to the string 
 <code>"true"</code>.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#hashCode()"><b>hashCode</b></a>()
  <dd>  Returns a hash code for this Boolean.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#toString()"><b>toString</b></a>()
  <dd>  Returns a String object representing this Boolean's value.
  <dt> <img src="images/green-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#valueOf(java.lang.String)"><b>valueOf</b></a>(String)
  <dd>  Returns the boolean value represented by the specified String.
</dl>
<a name="variables"></a>
<h2>
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
</h2>
<a name="TRUE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>TRUE</b>
<pre>
 public static final <a href="#_top_">Boolean</a> TRUE
</pre>
<dl>
  <dd> The <code>Boolean</code> object corresponding to the primitive 
 value <code>true</code>.<p>
</dl>
<a name="FALSE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>FALSE</b>
<pre>
 public static final <a href="#_top_">Boolean</a> FALSE
</pre>
<dl>
  <dd> The <code>Boolean</code> object corresponding to the primitive 
 value <code>false</code>.<p>
</dl>
<a name="TYPE"><img src="images/blue-ball.gif" width=12 height=12 alt=" o "></a>
<b>TYPE</b>
<pre>
 public static final <a href="java.lang.Class.html#_top_">Class</a> TYPE
</pre>
<dl>
  <dd> The Class object representing the primitive type boolean.<p>
</dl>
<a name="constructors"></a>
<h2>
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
</h2>
<a name="Boolean"></a>
<a name="Boolean(boolean)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
<b>Boolean</b>
<pre>
 public Boolean(boolean value)
</pre>
<dl>
  <dd> Allocates a <code>Boolean</code> object representing the 
 <code>value</code> argument.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> value - the value of the <code>Boolean</code>.
  </dl></dd>
</dl>
<a name="Boolean(java.lang.String)"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
<b>Boolean</b>
<pre>
 public Boolean(<a href="java.lang.String.html#_top_">String</a> s)
</pre>
<dl>
  <dd> Allocates a <code>Boolean</code> object representing the value 
 <code>true</code> if the string argument is not <code>null</code> 
 and is equal, ignoring case, to the string <code>"true"</code>. 
 Otherwise, allocate a <code>Boolean</code> object representing the 
 value <code>false</code>.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> s - the string to be converted to a <code>Boolean</code>.
  </dl></dd>
</dl>
<a name="methods"></a>
<h2>
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
</h2>
<a name="booleanValue()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="booleanValue"><b>booleanValue</b></a>
<pre>
 public boolean booleanValue()
</pre>
<dl>
  <dd> Returns the value of this Boolean object as a boolean.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> the primitive <code>boolean</code> value of this object.
  </dl></dd>
</dl>
<a name="valueOf(java.lang.String)"><img src="images/green-ball.gif" width=12 height=12 alt=" o "></a>
<a name="valueOf"><b>valueOf</b></a>
<pre>
 public static <a href="#_top_">Boolean</a> valueOf(<a href="java.lang.String.html#_top_">String</a> s)
</pre>
<dl>
  <dd> Returns the boolean value represented by the specified String.
 A new <code>Boolean</code> object is constructed. This 
 <code>Boolean</code> contains the value <code>true</code> if the 
 string argument is not <code>null</code> and is equal, ignoring 
 case, to the string <code>"true"</code>.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> s - a string.
    <dt> <b>Returns:</b>
    <dd> the <code>Boolean</code> value represented by the string.
  </dl></dd>
</dl>
<a name="toString()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="toString"><b>toString</b></a>
<pre>
 public <a href="java.lang.String.html#_top_">String</a> toString()
</pre>
<dl>
  <dd> Returns a String object representing this Boolean's value.
 If this object contains the value <code>true</code>, a string equal 
 to <code>"true"</code> is returned. Otherwise, a string equal to 
 <code>"false"</code> is returned.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> a string representation of this object.
    <dt> <b>Overrides:</b>
    <dd> <a href="java.lang.Object.html#toString()">toString</a> in class <a href="java.lang.Object.html#_top_">Object</a>
  </dl></dd>
</dl>
<a name="hashCode()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="hashCode"><b>hashCode</b></a>
<pre>
 public int hashCode()
</pre>
<dl>
  <dd> Returns a hash code for this Boolean.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> a hash code value for this object.
    <dt> <b>Overrides:</b>
    <dd> <a href="java.lang.Object.html#hashCode()">hashCode</a> in class <a href="java.lang.Object.html#_top_">Object</a>
  </dl></dd>
</dl>
<a name="equals(java.lang.Object)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="equals"><b>equals</b></a>
<pre>
 public boolean equals(<a href="java.lang.Object.html#_top_">Object</a> obj)
</pre>
<dl>
  <dd> Returns <code>true</code> if and only if the argument is not 
 <code>null</code> and is a <code>Boolean </code>object that 
 contains the same <code>boolean</code> value as this object.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> obj - the object to compare with.
    <dt> <b>Returns:</b>
    <dd> <code>true</code> if the objects are the same;
          <code>false</code> otherwise.
    <dt> <b>Overrides:</b>
    <dd> <a href="java.lang.Object.html#equals(java.lang.Object)">equals</a> in class <a href="java.lang.Object.html#_top_">Object</a>
  </dl></dd>
</dl>
<a name="getBoolean(java.lang.String)"><img src="images/green-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getBoolean"><b>getBoolean</b></a>
<pre>
 public static boolean getBoolean(<a href="java.lang.String.html#_top_">String</a> name)
</pre>
<dl>
  <dd> Returns is <code>true</code> if and only if the system property 
 named by the argument exists and is equal to the string 
 <code>"true"</code>. (Beginning with Java 1.0.2, the test of 
 this string is case insensitive.) A system property is accessible 
 through <code>getProperty</code>, a method defined by the 
 <code>System</code> class.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> name - the system property name.
    <dt> <b>Returns:</b>
    <dd> the <code>boolean</code> value of the system property.
    <dt> <b>See Also:</b>
    <dd> <a href="java.lang.System.html#getProperty(java.lang.String)">getProperty</a>, <a href="java.lang.System.html#getProperty(java.lang.String, java.lang.String)">getProperty</a>
  </dl></dd>
</dl>
<hr>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.lang.html">This Package</a>  <a href="Package-java.lang.html">Previous</a>  <a href="java.lang.Byte.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
</body>
</html>
