/* Boolean.java -- object wrapper for boolean
Copyright (C) 1998, 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath 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 for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
As a special exception, if you link this library with other files to
produce an executable, this library does not by itself cause the
resulting executable to be covered by the GNU General Public License.
This exception does not however invalidate any other reasons why the
executable file might be covered by the GNU General Public License. */
package java.lang;
import java.io.Serializable;
/**
* Instances of class Boolean
represent primitive
* boolean
values.
*
* @author Paul Fisher
* @since JDK1.0
*/
public final class Boolean implements Serializable
{
static final long serialVersionUID = -3665804199014368530L;
/**
* This field is a Boolean
object representing the
* primitive value true
. This instance is returned
* by the static valueOf()
methods if they return
* a Boolean
representing true
.
*/
public static final Boolean TRUE = new Boolean(true);
/**
* This field is a Boolean
object representing the
* primitive value false
. This instance is returned
* by the static valueOf()
methods if they return
* a Boolean
representing false
.
*/
public static final Boolean FALSE = new Boolean(false);
/**
* The primitive type boolean
is represented by this
* Class
object.
*/
public static final Class TYPE = VMClassLoader.getPrimitiveClass("boolean");
/**
* The immutable value of this Boolean.
*/
private final boolean value;
/**
* Create a Boolean
object representing the value of the
* argument value
. In general the use of the static
* method valueof(boolean)
is more efficient since it will
* not create a new object.
*
* @param value the primitive value of this Boolean
*/
public Boolean(boolean value) {
this.value = value;
}
/**
* Creates a Boolean
object representing the primitive
* true
if and only if s
matches
* the string "true" ignoring case, otherwise the object will represent
* the primitive false
. In general the use of the static
* method valueof(String)
is more efficient since it will
* not create a new object.
*
* @param s the String
representation of true
* or false
*/
public Boolean(String s) {
value = "true".equalsIgnoreCase(s);
}
/**
* Return the primitive boolean
value of this
* Boolean
object.
*/
public boolean booleanValue() {
return value;
}
/**
* Returns the Boolean TRUE
if the given boolean is
* true
, otherwise it will return the Boolean
* FALSE
.
*
* @since 1.4
*/
public static Boolean valueOf(boolean b) {
return b ? TRUE : FALSE;
}
/**
* Returns the Boolean TRUE
if and only if the given
* String is equal, ignoring case, to the the String "true", otherwise
* it will return the Boolean FALSE
.
*/
public static Boolean valueOf(String s) {
return "true".equalsIgnoreCase(s) ? TRUE : FALSE;
}
/**
* Returns the integer 1231
if this object represents
* the primitive true
and the integer 1237
* otherwise.
*/
public int hashCode() {
return (value) ? 1231 : 1237;
}
/**
* If the obj
is an instance of Boolean
and
* has the same primitive value as this object then true
* is returned. In all other cases, including if the obj
* is null
, false
is returned.
*
* @param obj possibly an instance of any Class
* @return false
is obj
is an instance of
* Boolean
and has the same primitive value as this
* object.
*/
public boolean equals(Object obj) {
return (obj instanceof Boolean && value == ((Boolean)obj).value);
}
/**
* If the value of the system property name
matches
* "true" ignoring case then the function returns true
.
*/
public static boolean getBoolean(String name) {
String val = System.getProperty(name);
return ("true".equalsIgnoreCase(val));
}
/**
* Returns "true" if the value of the give boolean is true
and
* returns "false" if the value of the given boolean is false
.
*
* @since 1.4
*/
public static String toString(boolean b)
{
return b ? "true" : "false";
}
/**
* Returns "true" if the value of this object is true
and
* returns "false" if the value of this object is false
.
*/
public String toString()
{
return (value) ? "true" : "false";
}
}