- java.lang.Object
-
- java.lang.Boolean
-
- All Implemented Interfaces:
Serializable,Comparable<Boolean>
public final class Boolean extends Object implements Serializable, Comparable<Boolean>
The Boolean class wraps a value of the primitive typebooleanin an object. An object of typeBooleancontains a single field whose type isboolean.In addition, this class provides many methods for converting a
booleanto aStringand aStringto aboolean, as well as other constants and methods useful when dealing with aboolean.- Since:
- 1.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static BooleanFALSETheBooleanobject corresponding to the primitive valuefalse.static BooleanTRUETheBooleanobject corresponding to the primitive valuetrue.static Class<Boolean>TYPEThe Class object representing the primitive type boolean.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanbooleanValue()Returns the value of thisBooleanobject as a boolean primitive.static intcompare(boolean x, boolean y)Compares twobooleanvalues.intcompareTo(Boolean b)Compares thisBooleaninstance with another.booleanequals(Object obj)Returnstrueif and only if the argument is notnulland is aBooleanobject that represents the samebooleanvalue as this object.static booleangetBoolean(String name)Returnstrueif and only if the system property named by the argument exists and is equal to, ignoring case, the string"true".inthashCode()Returns a hash code for thisBooleanobject.static inthashCode(boolean value)Returns a hash code for abooleanvalue; compatible withBoolean.hashCode().static booleanlogicalAnd(boolean a, boolean b)Returns the result of applying the logical AND operator to the specifiedbooleanoperands.static booleanlogicalOr(boolean a, boolean b)Returns the result of applying the logical OR operator to the specifiedbooleanoperands.static booleanlogicalXor(boolean a, boolean b)Returns the result of applying the logical XOR operator to the specifiedbooleanoperands.static booleanparseBoolean(String s)Parses the string argument as a boolean.StringtoString()Returns aStringobject representing this Boolean's value.static StringtoString(boolean b)Returns aStringobject representing the specified boolean.static BooleanvalueOf(boolean b)Returns aBooleaninstance representing the specifiedbooleanvalue.static BooleanvalueOf(String s)Returns aBooleanwith a value represented by the specified string.
-
-
-
Constructor Detail
-
Boolean
@Deprecated(since="9") public Boolean(boolean value)
Deprecated.It is rarely appropriate to use this constructor. The static factoryvalueOf(boolean)is generally a better choice, as it is likely to yield significantly better space and time performance. Also consider using the final fieldsTRUEandFALSEif possible.Allocates aBooleanobject representing thevalueargument.- Parameters:
value- the value of theBoolean.
-
Boolean
@Deprecated(since="9") public Boolean(String s)
Deprecated.It is rarely appropriate to use this constructor. UseparseBoolean(String)to convert a string to abooleanprimitive, or usevalueOf(String)to convert a string to aBooleanobject.Allocates aBooleanobject representing the valuetrueif the string argument is notnulland is equal, ignoring case, to the string"true". Otherwise, allocates aBooleanobject representing the valuefalse.- Parameters:
s- the string to be converted to aBoolean.
-
-
Method Detail
-
parseBoolean
public static boolean parseBoolean(String s)
Parses the string argument as a boolean. Thebooleanreturned represents the valuetrueif the string argument is notnulland is equal, ignoring case, to the string"true". Otherwise, a false value is returned, including for a null argument.Example:
Boolean.parseBoolean("True")returnstrue.
Example:Boolean.parseBoolean("yes")returnsfalse.- Parameters:
s- theStringcontaining the boolean representation to be parsed- Returns:
- the boolean represented by the string argument
- Since:
- 1.5
-
booleanValue
public boolean booleanValue()
Returns the value of thisBooleanobject as a boolean primitive.- Returns:
- the primitive
booleanvalue of this object.
-
valueOf
public static Boolean valueOf(boolean b)
Returns aBooleaninstance representing the specifiedbooleanvalue. If the specifiedbooleanvalue istrue, this method returnsBoolean.TRUE; if it isfalse, this method returnsBoolean.FALSE. If a newBooleaninstance is not required, this method should generally be used in preference to the constructorBoolean(boolean), as this method is likely to yield significantly better space and time performance.- Parameters:
b- a boolean value.- Returns:
- a
Booleaninstance representingb. - Since:
- 1.4
-
valueOf
public static Boolean valueOf(String s)
Returns aBooleanwith a value represented by the specified string. TheBooleanreturned represents a true value if the string argument is notnulland is equal, ignoring case, to the string"true". Otherwise, a false value is returned, including for a null argument.- Parameters:
s- a string.- Returns:
- the
Booleanvalue represented by the string.
-
toString
public static String toString(boolean b)
Returns aStringobject representing the specified boolean. If the specified boolean istrue, then the string"true"will be returned, otherwise the string"false"will be returned.- Parameters:
b- the boolean to be converted- Returns:
- the string representation of the specified
boolean - Since:
- 1.4
-
toString
public String toString()
Returns aStringobject representing this Boolean's value. If this object represents the valuetrue, a string equal to"true"is returned. Otherwise, a string equal to"false"is returned.
-
hashCode
public int hashCode()
Returns a hash code for thisBooleanobject.- Overrides:
hashCodein classObject- Returns:
- the integer
1231if this object representstrue; returns the integer1237if this object representsfalse. - See Also:
Object.equals(java.lang.Object)
-
hashCode
public static int hashCode(boolean value)
Returns a hash code for abooleanvalue; compatible withBoolean.hashCode().- Parameters:
value- the value to hash- Returns:
- a hash code value for a
booleanvalue. - Since:
- 1.8
-
equals
public boolean equals(Object obj)
Returnstrueif and only if the argument is notnulland is aBooleanobject that represents the samebooleanvalue as this object.- Overrides:
equalsin classObject- Parameters:
obj- the object to compare with.- Returns:
trueif the Boolean objects represent the same value;falseotherwise.- See Also:
Object.hashCode()
-
getBoolean
public static boolean getBoolean(String name)
Returnstrueif and only if the system property named by the argument exists and is equal to, ignoring case, the string"true". A system property is accessible throughgetProperty, a method defined by theSystemclass.If there is no property with the specified name, or if the specified name is empty or null, then
falseis returned.- Parameters:
name- the system property name.- Returns:
- the
booleanvalue of the system property. - Throws:
SecurityException- for the same reasons asSystem.getProperty- See Also:
System.getProperty(java.lang.String),System.getProperty(java.lang.String, java.lang.String)
-
compareTo
public int compareTo(Boolean b)
Compares thisBooleaninstance with another.- Specified by:
compareToin interfaceComparable<Boolean>- Parameters:
b- theBooleaninstance to be compared- Returns:
- zero if this object represents the same boolean value as the argument; a positive value if this object represents true and the argument represents false; and a negative value if this object represents false and the argument represents true
- Throws:
NullPointerException- if the argument isnull- Since:
- 1.5
- See Also:
Comparable
-
compare
public static int compare(boolean x, boolean y)Compares twobooleanvalues. The value returned is identical to what would be returned by:Boolean.valueOf(x).compareTo(Boolean.valueOf(y))- Parameters:
x- the firstbooleanto comparey- the secondbooleanto compare- Returns:
- the value
0ifx == y; a value less than0if!x && y; and a value greater than0ifx && !y - Since:
- 1.7
-
logicalAnd
public static boolean logicalAnd(boolean a, boolean b)Returns the result of applying the logical AND operator to the specifiedbooleanoperands.- Parameters:
a- the first operandb- the second operand- Returns:
- the logical AND of
aandb - Since:
- 1.8
- See Also:
BinaryOperator
-
logicalOr
public static boolean logicalOr(boolean a, boolean b)Returns the result of applying the logical OR operator to the specifiedbooleanoperands.- Parameters:
a- the first operandb- the second operand- Returns:
- the logical OR of
aandb - Since:
- 1.8
- See Also:
BinaryOperator
-
logicalXor
public static boolean logicalXor(boolean a, boolean b)Returns the result of applying the logical XOR operator to the specifiedbooleanoperands.- Parameters:
a- the first operandb- the second operand- Returns:
- the logical XOR of
aandb - Since:
- 1.8
- See Also:
BinaryOperator
-
-