java.lang
Class Boolean

java.lang.Object
  extended by java.lang.Boolean
All Implemented Interfaces:
Serializable, Comparable<Boolean>

public final class Boolean
extends Object
implements Serializable, Comparable<Boolean>

Instances of class Boolean represent primitive boolean values.

Since:
1.0
See Also:
Serialized Form

Field Summary
static Boolean FALSE
          This field is a Boolean object representing the primitive value false.
static Boolean TRUE
          This field is a Boolean object representing the primitive value true.
static Class<Boolean> TYPE
          The primitive type boolean is represented by this Class object.
 
Constructor Summary
Boolean(boolean value)
          Create a Boolean object representing the value of the argument value.
Boolean(String s)
          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.
 
Method Summary
 boolean booleanValue()
          Return the primitive boolean value of this Boolean object.
 int compareTo(Boolean other)
          Compares this Boolean to another.
 boolean equals(Object obj)
          If the obj is an instance of Boolean and has the same primitive value as this object then true is returned.
static boolean getBoolean(String name)
          If the value of the system property name matches "true" ignoring case then the function returns true.
 int hashCode()
          Returns the integer 1231 if this object represents the primitive true and the integer 1237 otherwise.
static boolean parseBoolean(String b)
          If the String argument is "true", ignoring case, return true.
 String toString()
          Returns "true" if the value of this object is true and returns "false" if the value of this object is false.
static String toString(boolean b)
          Returns "true" if the value of the give boolean is true and returns "false" if the value of the given boolean is false.
static Boolean valueOf(boolean b)
          Returns the Boolean TRUE if the given boolean is true, otherwise it will return the Boolean FALSE.
static Boolean valueOf(String s)
          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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

TRUE

public static final Boolean TRUE
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.


FALSE

public static final Boolean FALSE
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.


TYPE

public static final Class<Boolean> TYPE
The primitive type boolean is represented by this Class object.

Since:
1.1
Constructor Detail

Boolean

public Boolean(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.

Parameters:
value - the primitive value of this Boolean
See Also:
valueOf(boolean)

Boolean

public Boolean(String s)
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.

Parameters:
s - the String representation of true or false
Method Detail

booleanValue

public boolean booleanValue()
Return the primitive boolean value of this Boolean object.

Returns:
true or false, depending on the value of this Boolean

valueOf

public static Boolean valueOf(boolean b)
Returns the Boolean TRUE if the given boolean is true, otherwise it will return the Boolean FALSE.

Parameters:
b - the boolean to wrap
Returns:
the wrapper object
Since:
1.4
See Also:
TRUE, FALSE

valueOf

public static Boolean valueOf(String s)
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.

Parameters:
s - the string to convert
Returns:
a wrapped boolean from the string

toString

public static String toString(boolean b)
Returns "true" if the value of the give boolean is true and returns "false" if the value of the given boolean is false.

Parameters:
b - the boolean to convert
Returns:
the string representation of the boolean
Since:
1.4

toString

public String toString()
Returns "true" if the value of this object is true and returns "false" if the value of this object is false.

Overrides:
toString in class Object
Returns:
the string representation of this
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

hashCode

public int hashCode()
Returns the integer 1231 if this object represents the primitive true and the integer 1237 otherwise.

Overrides:
hashCode in class Object
Returns:
the hash code
See Also:
Object.equals(Object), System.identityHashCode(Object)

equals

public boolean equals(Object obj)
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.

Overrides:
equals in class Object
Parameters:
obj - possibly an instance of any Class
Returns:
true if obj equals this
See Also:
Object.hashCode()

getBoolean

public static boolean getBoolean(String name)
If the value of the system property name matches "true" ignoring case then the function returns true.

Parameters:
name - the property name to look up
Returns:
true if the property resulted in "true"
Throws:
SecurityException - if accessing the system property is forbidden
See Also:
System.getProperty(String)

compareTo

public int compareTo(Boolean other)
Compares this Boolean to another.

Specified by:
compareTo in interface Comparable<Boolean>
Parameters:
other - the Boolean to compare this Boolean to
Returns:
0 if both Booleans represent the same value, a positive number if this Boolean represents true and the other false, and a negative number otherwise.
Since:
1.5

parseBoolean

public static boolean parseBoolean(String b)
If the String argument is "true", ignoring case, return true. Otherwise, return false.

Parameters:
b - String to parse
Since:
1.5