sample/java.lang.Boolean.txt

   1 *java.lang.Boolean* *Boolean* The Boolean class wraps a value of the primitive t
   2
   3 public final class Boolean
   4   extends    |java.lang.Object|
   5   implements |java.io.Serializable|
   6              |java.lang.Comparable|
   7
   8 |java.lang.Boolean_Description|
   9 |java.lang.Boolean_Fields|
  10 |java.lang.Boolean_Constructors|
  11 |java.lang.Boolean_Methods|
  12
  13 ================================================================================
  14
  15 *java.lang.Boolean_Fields*
  16 |java.lang.Boolean_java.lang.Boolean.FALSE|
  17 |java.lang.Boolean_java.lang.Boolean.TRUE|
  18 |java.lang.Class_java.lang.Boolean.TYPE|
  19
  20 *java.lang.Boolean_Constructors*
  21 |java.lang.Boolean(boolean)|Allocates a Boolean object representing the   value
  22 |java.lang.Boolean(String)|Allocates a Boolean object representing the value
  23
  24 *java.lang.Boolean_Methods*
  25 |java.lang.Boolean.booleanValue()|Returns the value of this Boolean object as a
  26 |java.lang.Boolean.compareTo(Boolean)|Compares this Boolean instance with anoth
  27 |java.lang.Boolean.equals(Object)|Returns true if and only if the argument is n
  28 |java.lang.Boolean.getBoolean(String)|Returns true if and only if the system pr
  29 |java.lang.Boolean.hashCode()|Returns a hash code for this Boolean object.
  30 |java.lang.Boolean.parseBoolean(String)|Parses the string argument as a boolean
  31 |java.lang.Boolean.toString()|Returns a String object representing this Boolean
  32 |java.lang.Boolean.toString(boolean)|Returns a String object representing the s
  33 |java.lang.Boolean.valueOf(boolean)|Returns a Boolean instance representing the
  34 |java.lang.Boolean.valueOf(String)|Returns a Boolean with a value represented b
  35
  36 *java.lang.Boolean_Description*
  37
  38 The Boolean class wraps a value of the primitive type boolean in an object. An
  39 object of type Boolean contains a single field whose type is boolean.
  40
  41 In addition, this class provides many methods for converting a boolean to a
  42 String and a String to a boolean, as well as other constants and methods useful
  43 when dealing with a boolean.
  44
  45
  46 *java.lang.Boolean_java.lang.Boolean.FALSE*
  47
  48 The Boolean class wraps a value of the primitive type boolean in an object. An
  49 object of type Boolean contains a single field whose type is boolean.
  50
  51 In addition, this class provides many methods for converting a boolean to a
  52 String and a String to a boolean, as well as other constants and methods useful
  53 when dealing with a boolean.
  54
  55
  56 *java.lang.Boolean_java.lang.Boolean.TRUE*
  57
  58 The Boolean class wraps a value of the primitive type boolean in an object. An
  59 object of type Boolean contains a single field whose type is boolean.
  60
  61 In addition, this class provides many methods for converting a boolean to a
  62 String and a String to a boolean, as well as other constants and methods useful
  63 when dealing with a boolean.
  64
  65
  66 *java.lang.Class_java.lang.Boolean.TYPE*
  67
  68 The Boolean class wraps a value of the primitive type boolean in an object. An
  69 object of type Boolean contains a single field whose type is boolean.
  70
  71 In addition, this class provides many methods for converting a boolean to a
  72 String and a String to a boolean, as well as other constants and methods useful
  73 when dealing with a boolean.
  74
  75
  76
  77 *java.lang.Boolean(boolean)*
  78
  79 public Boolean(boolean value)
  80
  81 Allocates a Boolean object representing the value argument.
  82
  83 Note: It is rarely appropriate to use this constructor. Unless a new instance
  84 is required, the static factory (|java.lang.Boolean|) is generally a better
  85 choice. It is likely to yield significantly better space and time performance.
  86
  87     value - the value of the Boolean.
  88
  89 *java.lang.Boolean(String)*
  90
  91 public Boolean(java.lang.String s)
  92
  93 Allocates a Boolean object representing the value true if the string argument
  94 is not null and is equal, ignoring case, to the string "true". Otherwise,
  95 allocate a Boolean object representing the value false. Examples:
  96 newBoolean("True") produces a Boolean object that represents true.
  97 newBoolean("yes") produces a Boolean object that represents false.
  98
  99     s - the string to be converted to a Boolean.
 100
 101 *java.lang.Boolean.booleanValue()*
 102
 103 public boolean booleanValue()
 104
 105 Returns the value of this Boolean object as a boolean primitive.
 106
 107
 108     Returns: the primitive boolean value of this object.
 109 *java.lang.Boolean.compareTo(Boolean)*
 110
 111 public int compareTo(java.lang.Boolean b)
 112
 113 Compares this Boolean instance with another.
 114
 115     b - the Boolean instance to be compared
 116
 117     Returns: zero if this object represents the same boolean value as the argument; a
 118              positive value if this object represents true and the argument
 119              represents false; and a negative value if this object represents
 120              false and the argument represents true
 121 *java.lang.Boolean.equals(Object)*
 122
 123 public boolean equals(java.lang.Object obj)
 124
 125 Returns true if and only if the argument is not null and is a Boolean object
 126 that represents the same boolean value as this object.
 127
 128     obj - the object to compare with.
 129
 130     Returns: true if the Boolean objects represent the same value; false otherwise.
 131 *java.lang.Boolean.getBoolean(String)*
 132
 133 public static boolean getBoolean(java.lang.String name)
 134
 135 Returns true if and only if the system property named by the argument exists
 136 and is equal to the string "true". (Beginning with version 1.0.2 of the JavaTM
 137 platform, the test of this string is case insensitive.) A system property is
 138 accessible through getProperty, a method defined by the System class.
 139
 140 If there is no property with the specified name, or if the specified name is
 141 empty or null, then false is returned.
 142
 143     name - the system property name.
 144
 145     Returns: the boolean value of the system property.
 146 *java.lang.Boolean.hashCode()*
 147
 148 public int hashCode()
 149
 150 Returns a hash code for this Boolean object.
 151
 152
 153     Returns: the integer 1231 if this object represents true; returns the integer 1237 if
 154              this object represents false.
 155 *java.lang.Boolean.parseBoolean(String)*
 156
 157 public static boolean parseBoolean(java.lang.String s)
 158
 159 Parses the string argument as a boolean. The boolean returned represents the
 160 value true if the string argument is not null and is equal, ignoring case, to
 161 the string "true".
 162
 163     s - the String containing the boolean representation to be parsed
 164
 165     Returns: the boolean represented by the string argument
 166 *java.lang.Boolean.toString()*
 167
 168 public |java.lang.String| toString()
 169
 170 Returns a String object representing this Boolean's value. If this object
 171 represents the value true, a string equal to "true" is returned. Otherwise, a
 172 string equal to "false" is returned.
 173
 174
 175     Returns: a string representation of this object.
 176 *java.lang.Boolean.toString(boolean)*
 177
 178 public static |java.lang.String| toString(boolean b)
 179
 180 Returns a String object representing the specified boolean. If the specified
 181 boolean is true, then the string "true" will be returned, otherwise the string
 182 "false" will be returned.
 183
 184     b - the boolean to be converted
 185
 186     Returns: the string representation of the specified boolean
 187 *java.lang.Boolean.valueOf(boolean)*
 188
 189 public static |java.lang.Boolean| valueOf(boolean b)
 190
 191 Returns a Boolean instance representing the specified boolean value. If the
 192 specified boolean value is true, this method returns Boolean.TRUE; if it is
 193 false, this method returns Boolean.FALSE. If a new Boolean instance is not
 194 required, this method should generally be used in preference to the constructor
 195 (|java.lang.Boolean|) , as this method is likely to yield significantly better
 196 space and time performance.
 197
 198     b - a boolean value.
 199
 200     Returns: a Boolean instance representing b.
 201 *java.lang.Boolean.valueOf(String)*
 202
 203 public static |java.lang.Boolean| valueOf(java.lang.String s)
 204
 205 Returns a Boolean with a value represented by the specified String. The Boolean
 206 returned represents the value true if the string argument is not null and is
 207 equal, ignoring case, to the string "true". Example: Boolean.valueOf("True")
 208 returns true. Example: Boolean.valueOf("yes") returns false.
 209
 210     s - a string.
 211
 212     Returns: the Boolean value represented by the string.
 213