java.lang
Class Boolean

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

public final class Boolean

extends Object

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

Version:

1.38, 02/02/00

Author:

Arthur van Hoff

Field Summary

static Boolean	FALSE The Boolean object corresponding to the primitive value false.
static Boolean	TRUE The Boolean object corresponding to the primitive value true.

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.
int	hashCode() Returns a hash code for this Boolean object.
String	toString() Returns a String object representing this Boolean's value.
static Boolean	valueOf(String s) Returns a Boolean with a value represented by the specified String.

Methods inherited from class java.lang.Object

clone, finalize, getClass

Field Detail

FALSE

public static final Boolean FALSE

The Boolean object corresponding to the primitive value false.

TRUE

public static final Boolean TRUE

The Boolean object corresponding to the primitive value true.

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.

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.

Overrides:

equals in class Object

Parameters:

obj - the object to compare with.

Returns:

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

See Also:

hashCode(), Hashtable

hashCode

public int hashCode()

Returns a hash code for this Boolean object.

Overrides:

hashCode in class Object

Returns:

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

See Also:

Object.equals(java.lang.Object), Hashtable

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.

Overrides:

toString in class Object

Returns:

a string representation of this object.

valueOf

public static Boolean valueOf(String s)

Returns a Boolean with a value represented by the specified String. The Boolean returned 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.