File	Doc	Category	Size	Date	Package
Boolean.java	API Doc	Java SE 5 API	8980	Fri Aug 26 14:57:00 BST 2005	java.lang

Boolean

• java.lang.Object

Fields Summary
public static final Boolean	TRUE The Boolean object corresponding to the primitive value true.
public static final Boolean	FALSE The Boolean object corresponding to the primitive value false.
public static final Class	TYPE The Class object representing the primitive type boolean.
private final boolean	value The value of the Boolean.
private static final long	serialVersionUID use serialVersionUID from JDK 1.0.2 for interoperability

Constructors Summary
public Boolean(boolean value) Allocates a Boolean object representing the value argument. Note: It is rarely appropriate to use this constructor. Unless a new instance is required, the static factory {@link #valueOf(boolean)} is generally a better choice. It is likely to yield significantly better space and time performance. param value the value of the Boolean. this.value = value;
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. param s the string to be converted to a Boolean. this(toBoolean(s));

Methods Summary
public boolean	booleanValue() Returns the value of this Boolean object as a boolean primitive. return the primitive boolean value of this object. return value;
public int	compareTo(java.lang.Boolean b) Compares this Boolean instance with another. param b the Boolean instance to be compared return 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 is null see Comparable since 1.5 return (b.value == value ? 0 : (value ? 1 : -1));
public boolean	equals(java.lang.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. param obj the object to compare with. return true if the Boolean objects represent the same value; false otherwise. if (obj instanceof Boolean) { return value == ((Boolean)obj).booleanValue(); } return false;
public static boolean	getBoolean(java.lang.String name) Returns true if and only if the system property named by the argument exists and is equal to the string "true". (Beginning with version 1.0.2 of the JavaTM platform, the test of this string is case insensitive.) 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. param name the system property name. return the boolean value of the system property. see java.lang.System#getProperty(java.lang.String) see java.lang.System#getProperty(java.lang.String, java.lang.String) boolean result = false; try { result = toBoolean(System.getProperty(name)); } catch (IllegalArgumentException e) { } catch (NullPointerException e) { } return result;
public int	hashCode() Returns a hash code for this Boolean object. return the integer 1231 if this object represents true; returns the integer 1237 if this object represents false. return value ? 1231 : 1237;
public static boolean	parseBoolean(java.lang.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". param s the String containing the boolean representation to be parsed return the boolean represented by the string argument since 1.5 return toBoolean(s);
private static boolean	toBoolean(java.lang.String name) return ((name != null) && name.equalsIgnoreCase("true"));
public static java.lang.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. param b the boolean to be converted return the string representation of the specified boolean since 1.4 return b ? "true" : "false";
public java.lang.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. return a string representation of this object. return value ? "true" : "false";
public static java.lang.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 {@link #Boolean(boolean)}, as this method is likely to yield significantly better space and time performance. param b a boolean value. return a Boolean instance representing b. since 1.4 return (b ? TRUE : FALSE);
public static java.lang.Boolean	valueOf(java.lang.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. param s a string. return the Boolean value represented by the string. return toBoolean(s) ? TRUE : FALSE;