APIdia Launch Partner
Top Description Fields Constructors Methods
java.lang

public final Class Boolean

extends Object
implements Serializable, Comparable<Boolean>, Constable
Class Inheritance
All Implemented Interfaces
java.lang.constant.Constable, java.lang.Comparable, java.io.Serializable
Annotations
@ValueBased
Imports
jdk.internal.vm.annotation.IntrinsicCandidate, java.lang.constant.Constable, .ConstantDescs, .DynamicConstantDesc, java.util.Optional
The Boolean class is the wrapper class for values of the primitive type boolean. 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.

This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail.

Author
Arthur van Hoff
Since
1.0

Field Summary

Modifier and TypeField and Description
public static final Boolean
FALSE

The Boolean object corresponding to the primitive value false.

private static final long
serialVersionUID

use serialVersionUID from JDK 1.0.2 for interoperability

public static final Boolean
TRUE

The Boolean object corresponding to the primitive value true.

public static final Class<Boolean>
TYPE

The Class object representing the primitive type boolean.

private final boolean
value

The value of the Boolean.

Constructor Summary

AccessConstructor and Description
public
Boolean(boolean
the value of the Boolean.
value)
Deprecated since 9. It is rarely appropriate to use this constructor.

Allocates a Boolean object representing the value argument.

public
Boolean(String
the string to be converted to a Boolean.
s)
Deprecated since 9. It is rarely appropriate to use this constructor.

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

Modifier and TypeMethod and Description
public boolean

Returns:

the primitive boolean value of this object.
booleanValue()

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

public static int

Returns:

the value 0 if x == y; a value less than 0 if !x && y; and a value greater than 0 if x && !y
compare(boolean
the first boolean to compare
x, boolean
the second boolean to compare
y)

Compares two boolean values.

public int

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
compareTo(Boolean
the Boolean instance to be compared
b)

Implements java.lang.Comparable.compareTo.

Compares this Boolean instance with another.

public Optional<DynamicConstantDesc<Boolean>>

Returns:

an Optional describing the Boolean instance
describeConstable()

Implements java.lang.constant.Constable.describeConstable.

Returns an Optional containing the nominal descriptor for this instance.

public boolean

Returns:

true if the Boolean objects represent the same value; false otherwise.
equals(Object
the object to compare with.
obj)

Overrides java.lang.Object.equals.

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.

public static boolean

Returns:

the boolean value of the system property.
getBoolean(String
the system property name.
name)

Returns true if and only if the system property named by the argument exists and is equal to, ignoring case, the string "true".

public int

Returns:

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

Overrides java.lang.Object.hashCode.

Returns a hash code for this Boolean object.

public static int

Returns:

a hash code value for a boolean value.
hashCode(boolean
the value to hash
value)

Returns a hash code for a boolean value; compatible with Boolean.hashCode().

public static boolean

Returns:

the logical AND of a and b
logicalAnd(boolean
the first operand
a, boolean
the second operand
b)

Returns the result of applying the logical AND operator to the specified boolean operands.

public static boolean

Returns:

the logical OR of a and b
logicalOr(boolean
the first operand
a, boolean
the second operand
b)

Returns the result of applying the logical OR operator to the specified boolean operands.

public static boolean

Returns:

the logical XOR of a and b
logicalXor(boolean
the first operand
a, boolean
the second operand
b)

Returns the result of applying the logical XOR operator to the specified boolean operands.

public static boolean

Returns:

the boolean represented by the string argument
parseBoolean(String
the String containing the boolean representation to be parsed
s)

Parses the string argument as a boolean.

public static String

Returns:

the string representation of the specified boolean
toString(boolean
the boolean to be converted
b)

Returns a String object representing the specified boolean.

public String

Returns:

a string representation of this object.
toString()

Overrides java.lang.Object.toString.

Returns a String object representing this Boolean's value.

public static Boolean

Returns:

a Boolean instance representing b.
valueOf(boolean
a boolean value.
b)

Returns a Boolean instance representing the specified boolean value.

public static Boolean

Returns:

the Boolean value represented by the string.
valueOf(String
a string.
s)

Returns a Boolean with a value represented by the specified string.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

FALSEback to summary
public static final Boolean FALSE

The Boolean object corresponding to the primitive value false.

serialVersionUIDback to summary
private static final long serialVersionUID

use serialVersionUID from JDK 1.0.2 for interoperability

Annotations
@Serial
TRUEback to summary
public static final Boolean TRUE

The Boolean object corresponding to the primitive value true.

TYPEback to summary
public static final Class<Boolean> TYPE

The Class object representing the primitive type boolean.

Since
1.1
valueback to summary
private final boolean value

The value of the Boolean.

Constructor Detail

Booleanback to summary
public Boolean(boolean value)

Deprecated

since 9.

It is rarely appropriate to use this constructor. The static factory valueOf(boolean) is generally a better choice, as it is likely to yield significantly better space and time performance. Also consider using the final fields TRUE and FALSE if possible.

Allocates a Boolean object representing the value argument.

Parameters
value:boolean

the value of the Boolean.

Annotations
@Deprecated
since:9
Booleanback to summary
public Boolean(String s)

Deprecated

since 9.

It is rarely appropriate to use this constructor. Use parseBoolean(String) to convert a string to a boolean primitive, or use valueOf(String) to convert a string to a Boolean object.

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, allocates a Boolean object representing the value false.

Parameters
s:String

the string to be converted to a Boolean.

Annotations
@Deprecated
since:9

Method Detail

booleanValueback to summary
public boolean booleanValue()

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

Returns:boolean

the primitive boolean value of this object.

Annotations
@IntrinsicCandidate
compareback to summary
public static int compare(boolean x, boolean y)

Compares two boolean values. The value returned is identical to what would be returned by: 

   Boolean.valueOf(x).compareTo(Boolean.valueOf(y))
Parameters
x:boolean

the first boolean to compare

y:boolean

the second boolean to compare

Returns:int

the value 0 if x == y; a value less than 0 if !x && y; and a value greater than 0 if x && !y

Since
1.7
compareToback to summary
public int compareTo(Boolean b)

Implements java.lang.Comparable.compareTo.

Compares this Boolean instance with another.

Parameters
b:Boolean

the Boolean instance to be compared

Returns:int

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

Exceptions
NullPointerException:
if the argument is null
Since
1.5
See Also
Comparable
describeConstableback to summary
public Optional<DynamicConstantDesc<Boolean>> describeConstable()

Implements java.lang.constant.Constable.describeConstable.

Returns an Optional containing the nominal descriptor for this instance.

Returns:Optional<DynamicConstantDesc<Boolean>>

an Optional describing the Boolean instance

Annotations
@Override
Since
15
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

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:Object

the object to compare with.

Returns:boolean

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

getBooleanback to summary
public static boolean getBoolean(String name)

Returns true if 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 through getProperty, a method defined by the System class.

If there is no property with the specified name, or if the specified name is empty or null, then false is returned.

Parameters
name:String

the system property name.

Returns:boolean

the boolean value of the system property.

See Also
java.lang.System#getProperty(java.lang.String), java.lang.System#getProperty(java.lang.String, java.lang.String)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this Boolean object.

Returns:int

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

Annotations
@Override
hashCodeback to summary
public static int hashCode(boolean value)

Returns a hash code for a boolean value; compatible with Boolean.hashCode().

Parameters
value:boolean

the value to hash

Returns:int

a hash code value for a boolean value.

Since
1.8
logicalAndback to summary
public static boolean logicalAnd(boolean a, boolean b)

Returns the result of applying the logical AND operator to the specified boolean operands.

Parameters
a:boolean

the first operand

b:boolean

the second operand

Returns:boolean

the logical AND of a and b

Since
1.8
See Also
java.util.function.BinaryOperator
logicalOrback to summary
public static boolean logicalOr(boolean a, boolean b)

Returns the result of applying the logical OR operator to the specified boolean operands.

Parameters
a:boolean

the first operand

b:boolean

the second operand

Returns:boolean

the logical OR of a and b

Since
1.8
See Also
java.util.function.BinaryOperator
logicalXorback to summary
public static boolean logicalXor(boolean a, boolean b)

Returns the result of applying the logical XOR operator to the specified boolean operands.

Parameters
a:boolean

the first operand

b:boolean

the second operand

Returns:boolean

the logical XOR of a and b

Since
1.8
See Also
java.util.function.BinaryOperator
parseBooleanback to summary
public static boolean parseBoolean(String s)

Parses the string argument as a boolean. The boolean returned represents the value true if the string argument is not null and is equal, ignoring case, to the string "true". Otherwise, a false value is returned, including for a null argument.

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

Parameters
s:String

the String containing the boolean representation to be parsed

Returns:boolean

the boolean represented by the string argument

Since
1.5
toStringback to summary
public static String toString(boolean b)

Returns a String object representing the specified boolean. If the specified boolean is true, then the string "true" will be returned, otherwise the string "false" will be returned.

Parameters
b:boolean

the boolean to be converted

Returns:String

the string representation of the specified boolean

Since
1.4
toStringback to summary
public String toString()

Overrides java.lang.Object.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:String

a string representation of this object.

Annotations
@Override
valueOfback to summary
public static Boolean valueOf(boolean b)

Returns a Boolean instance representing the specified boolean value. If the specified boolean value is true, this method returns Boolean.TRUE; if it is false, this method returns Boolean.FALSE. If a new Boolean instance is not required, this method should generally be used in preference to the constructor Boolean(boolean), as this method is likely to yield significantly better space and time performance.

Parameters
b:boolean

a boolean value.

Returns:Boolean

a Boolean instance representing b.

Annotations
@IntrinsicCandidate
Since
1.4
valueOfback to summary
public static Boolean valueOf(String s)

Returns a Boolean with a value represented by the specified string. The Boolean returned represents a true value if the string argument is not null and is equal, ignoring case, to the string "true". Otherwise, a false value is returned, including for a null argument.

Parameters
s:String

a string.

Returns:Boolean

the Boolean value represented by the string.