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>_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
  47 *java.lang.Boolean_java.lang.Boolean.FALSE*
  48
  49 The Boolean object corresponding to the primitive value false.
  50
  51
  52 *java.lang.Boolean_java.lang.Boolean.TRUE*
  53
  54 The Boolean object corresponding to the primitive value true.
  55
  56
  57 *java.lang.Class<java.lang.Boolean>_java.lang.Boolean.TYPE*
  58
  59 The Class object representing the primitive type boolean.
  60
  61
  62
  63 *java.lang.Boolean(boolean)*
  64
  65 public Boolean(boolean value)
  66
  67 Allocates a Boolean object representing the value argument.
  68
  69 Note: It is rarely appropriate to use this constructor. Unless a new instance
  70 is required, the static factory (|java.lang.Boolean|) is generally a better
  71 choice. It is likely to yield significantly better space and time performance.
  72
  73     value - the value of the Boolean.
  74
  75 *java.lang.Boolean(String)*
  76
  77 public Boolean(java.lang.String s)
  78
  79 Allocates a Boolean object representing the value true if the string argument
  80 is not null and is equal, ignoring case, to the string"true". Otherwise,
  81 allocate a Boolean object representing the value false. Examples:new
  82 Boolean("True")produces a Boolean object that represents true.new
  83 Boolean("yes")produces a Boolean object that represents false.
  84
  85     s - the string to be converted to a Boolean.
  86
  87 *java.lang.Boolean.booleanValue()*
  88
  89 public boolean booleanValue()
  90
  91 Returns the value of this Boolean object as a boolean primitive.
  92
  93
  94
  95     Returns: the primitive boolean value of this object.
  96
  97 *java.lang.Boolean.compareTo(Boolean)*
  98
  99 public int compareTo(java.lang.Boolean b)
 100
 101 Compares this Boolean instance with another.
 102
 103
 104     b - the Boolean instance to be compared
 105
 106     Returns: zero if this object represents the same boolean value as the argument; a
 107              positive value if this object represents true and the argument
 108              represents false; and a negative value if this object represents
 109              false and the argument represents true
 110
 111 *java.lang.Boolean.equals(Object)*
 112
 113 public boolean equals(java.lang.Object obj)
 114
 115 Returns true if and only if the argument is not null and is a Boolean object
 116 that represents the same boolean value as this object.
 117
 118
 119     obj - the object to compare with.
 120
 121     Returns: true if the Boolean objects represent the same value; false otherwise.
 122
 123 *java.lang.Boolean.getBoolean(String)*
 124
 125 public static boolean getBoolean(java.lang.String name)
 126
 127 Returns true if and only if the system property named by the argument exists
 128 and is equal to the string"true". (Beginning with version 1.0.2 of the JavaTM
 129 platform, the test of this string is case insensitive.) A system property is
 130 accessible through getProperty, a method defined by the System class.
 131
 132 If there is no property with the specified name, or if the specified name is
 133 empty or null, then false is returned.
 134
 135
 136     name - the system property name.
 137
 138     Returns: the boolean value of the system property.
 139
 140 *java.lang.Boolean.hashCode()*
 141
 142 public int hashCode()
 143
 144 Returns a hash code for this Boolean object.
 145
 146
 147
 148     Returns: the integer 1231 if this object represents true; returns the integer 1237 if
 149              this object represents false.
 150
 151 *java.lang.Boolean.parseBoolean(String)*
 152
 153 public static boolean parseBoolean(java.lang.String s)
 154
 155 Parses the string argument as a boolean. The boolean returned represents the
 156 value true if the string argument is not null and is equal, ignoring case, to
 157 the string"true". Example:Boolean.parseBoolean("True")returns true.
 158 Example:Boolean.parseBoolean("yes")returns false.
 159
 160
 161     s - the String containing the boolean representation to be parsed
 162
 163     Returns: the boolean represented by the string argument
 164
 165 *java.lang.Boolean.toString()*
 166
 167 public |java.lang.String| toString()
 168
 169 Returns a String object representing this Boolean's value. If this object
 170 represents the value true, a string equal to"true"is returned. Otherwise, a
 171 string equal to"false"is returned.
 172
 173
 174
 175     Returns: a string representation of this object.
 176
 177 *java.lang.Boolean.toString(boolean)*
 178
 179 public static |java.lang.String| toString(boolean b)
 180
 181 Returns a String object representing the specified boolean. If the specified
 182 boolean is true, then the string"true"will be returned, otherwise the
 183 string"false"will be returned.
 184
 185
 186     b - the boolean to be converted
 187
 188     Returns: the string representation of the specified boolean
 189
 190 *java.lang.Boolean.valueOf(boolean)*
 191
 192 public static |java.lang.Boolean| valueOf(boolean b)
 193
 194 Returns a Boolean instance representing the specified boolean value. If the
 195 specified boolean value is true, this method returns Boolean.TRUE; if it is
 196 false, this method returns Boolean.FALSE. If a new Boolean instance is not
 197 required, this method should generally be used in preference to the constructor
 198 (|java.lang.Boolean|) , as this method is likely to yield significantly better
 199 space and time performance.
 200
 201
 202     b - a boolean value.
 203
 204     Returns: a Boolean instance representing b.
 205
 206 *java.lang.Boolean.valueOf(String)*
 207
 208 public static |java.lang.Boolean| valueOf(java.lang.String s)
 209
 210 Returns a Boolean with a value represented by the specified string. The Boolean
 211 returned represents a true value if the string argument is not null and is
 212 equal, ignoring case, to the string"true".
 213
 214
 215     s - a string.
 216
 217     Returns: the Boolean value represented by the string.
 218
 219