java.lang
Class Boolean

java.lang.Object
  |
  +--java.lang.Boolean

public final class Boolean

extends Object

implements Serializable

The Boolean class wraps a value of the primitive type boolean in an object. An object of type Boolean contains a single field whose type is boolean.

In addition, this class provides many methods for converting a boolean to a String and a String to a boolean, as well as other constants and methods useful when dealing with a boolean.

Since:

JDK1.0

See Also:

Serialized Form

Field Summary

static Boolean	FALSE The Boolean object corresponding to the primitive value false.
private static long	serialVersionUID use serialVersionUID from JDK 1.0.2 for interoperability
static Boolean	TRUE The Boolean object corresponding to the primitive value true.
static Class	TYPE The Class object representing the primitive type boolean.
private boolean	value The value of the Boolean.

Constructor Summary

Boolean(boolean value)
Allocates a Boolean object representing the value argument.

Boolean(String s)
Allocates a Boolean object representing the value true if the string argument is not null and is equal, ignoring case, to the string "true".

Method Summary

boolean	booleanValue() Returns the value of this Boolean object as a boolean primitive.
boolean	equals(Object obj) Returns true if and only if the argument is not null and is a Boolean object that represents the same boolean value as this object.
static boolean	getBoolean(String name) Returns true if and only if the system property named by the argument exists and is equal to the string "true".
int	hashCode() Returns a hash code for this Boolean object.
private static boolean	toBoolean(String name)
String	toString() Returns a String object representing this Boolean's value.
static Boolean	valueOf(String s) Returns the boolean value represented by the specified String.

Methods inherited from class java.lang.Object

, clone, finalize, getClass, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

TRUE

public static final Boolean TRUE

The Boolean object corresponding to the primitive value true.

FALSE

public static final Boolean FALSE

The Boolean object corresponding to the primitive value false.

TYPE

public static final Class TYPE

The Class object representing the primitive type boolean.

Since:

JDK1.1

value

private boolean value

The value of the Boolean.

serialVersionUID

private static final long serialVersionUID

use serialVersionUID from JDK 1.0.2 for interoperability

Constructor Detail

Boolean

public Boolean(boolean value)

Allocates a Boolean object representing the value argument.

Parameters:

value - the value of the Boolean.

Boolean

public Boolean(String s)

Allocates a Boolean object representing the value true if the string argument is not null and is equal, ignoring case, to the string "true". Otherwise, allocate a Boolean object representing the value false. Examples:

new Boolean("True") produces a Boolean object that represents true.
new Boolean("yes") produces a Boolean object that represents false.

Parameters:

s - the string to be converted to a Boolean.

Method Detail

booleanValue

public boolean booleanValue()

Returns the value of this Boolean object as a boolean primitive.

Returns:

the primitive boolean value of this object.

valueOf

public static Boolean valueOf(String s)

Returns the boolean value represented by the specified String. A new Boolean object is constructed. This Boolean represents the value true if the string argument is not null and is equal, ignoring case, to the string "true".

Example: Boolean.valueOf("True") returns true.
Example: Boolean.valueOf("yes") returns false.

Parameters:

s - a string.

Returns:

the Boolean value represented by the string.

toString

public String toString()

Returns a String object representing this Boolean's value. If this object represents the value true, a string equal to "true" is returned. Otherwise, a string equal to "false" is returned.

Returns:

a string representation of this object.

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code for this Boolean object.

Returns:

the integer 1231 if this object represents true; returns the integer 1237 if this object represents false.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Returns true if and only if the argument is not null and is a Boolean object that represents the same boolean value as this object.

Parameters:

obj - the object to compare with.

Returns:

true if the Boolean objects represent the same value; false otherwise.

Overrides:

equals in class Object

getBoolean

public static boolean getBoolean(String name)

Returns true if and only if the system property named by the argument exists and is equal to the string "true". (Beginning with version 1.0.2 of the Java^TM platform, the test of this string is case insensitive.) A system property is accessible through getProperty, a method defined by the System class.

Parameters:

name - the system property name.

Returns:

the boolean value of the system property.

See Also:

System.getProperty(java.lang.String), System.getProperty(java.lang.String, java.lang.String)

toBoolean

private static boolean toBoolean(String name)