Boolean

Fields

public static final Boolean FALSE

Since: API Level 1

The Boolean object that represents the primitive value false.

public static final Boolean TRUE

Since: API Level 1

The Boolean object that represents the primitive value true.

public static final Class<Boolean> TYPE

Since: API Level 1

The Class object that represents the primitive type boolean.

Public Constructors

public Boolean (String string)

Since: API Level 1

Constructs a new Boolean with its boolean value specified by string. If string is not null and is equal to "true" using a non-case sensitive comparison, the result will be a Boolean representing the primitive value true, otherwise it will be a Boolean representing the primitive value false.

Parameters

string

the string representing a boolean value.

public Boolean (boolean value)

Since: API Level 1

Constructs a new Boolean with the specified primitive boolean value.

Parameters

value

the primitive boolean value, true or false.

Public Methods

public boolean booleanValue ()

Since: API Level 1

Gets the primitive value of this boolean, either true or false.

Returns

• this object's primitive value, true or false.

public int compareTo (Boolean that)

Since: API Level 1

Compares this object to the specified boolean object to determine their relative order.

Parameters

that

the boolean object to compare this object to.

Returns

• 0 if the value of this boolean and the value of that are equal; a positive value if the value of this boolean is true and the value of that is false; a negative value if the value if this boolean is false and the value of that is true.

See Also

• Comparable

public boolean equals (Object o)

Since: API Level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must be an instance of Boolean and have the same boolean value as this object.

Parameters

o

the object to compare this boolean with.

Returns

• true if the specified object is equal to this Boolean; false otherwise.

public static boolean getBoolean (String string)

Since: API Level 1

Returns the boolean value of the system property identified by string.

Parameters

string

the name of the requested system property.

Returns

• true if the system property named by string exists and it is equal to "true" using case insensitive comparison, false otherwise.

See Also

• getProperty(String)

public int hashCode ()

Since: API Level 1

Returns an integer hash code for this boolean.

Returns

• this boolean's hash code, which is 1231 for true values and 1237 for false values.

public static boolean parseBoolean (String s)

Since: API Level 1

Parses the specified string as a boolean.

Parameters

s

the string representation of a boolean value.

Returns

• true if s is not null and is equal to "true" using case insensitive comparison, false otherwise.

public static String toString (boolean value)

Since: API Level 1

Converts the specified boolean to its string representation.

Parameters

value

the boolean to convert.

Returns

• "true" if value is true, "false" otherwise.

public String toString ()

Since: API Level 1

Returns a string containing a concise, human-readable description of this boolean.

Returns

• "true" if the value of this boolean is true, "false" otherwise.

public static Boolean valueOf (String string)

Since: API Level 1

Parses the specified string as a boolean value.

Parameters

string

the string representation of a boolean value.

Returns

• Boolean.TRUE if string is equal to "true" using case insensitive comparison, Boolean.FALSE otherwise.

See Also

• parseBoolean(String)

public static Boolean valueOf (boolean b)

Since: API Level 1

Returns a Boolean instance for the specified boolean value.

If it is not necessary to get a new Boolean instance, it is recommended to use this method instead of the constructor, since it returns its static instances, which results in better performance.

Parameters

b

the boolean to convert to a Boolean.

Returns

• Boolean.TRUE if b is equal to true, Boolean.FALSE otherwise.