BooleanCp (SeisNetWatch Source Code Documentation)

java.lang.Object
- java.lang.Number
- - com.isti.util.BooleanCp

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable
```
public class BooleanCp
extends java.lang.Number
implements java.lang.Comparable, java.io.Serializable
```
Class BooleanCp is a 'Boolean'-like wrapper class which holds a boolean value and implements the Comparable interface.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static BooleanCp`	`FALSE` The `BooleanCp` object corresponding to the primitive value `false`.
`static BooleanCp`	`TRUE` The `BooleanCp` object corresponding to the primitive value `true`.

Constructor Summary

Constructors
Constructor and Description
`BooleanCp(boolean value)` Deprecated. 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.
`BooleanCp(java.lang.Boolean bObj)` Deprecated. 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.
`BooleanCp(java.lang.String str)` Deprecated. It is rarely appropriate to use this constructor. The static factory `valueOf(String)` 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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()` Returns the value of this BooleanCp object as a boolean primitive.
`byte`	`byteValue()` Returns the value of this object as a byte.
`int`	`compareTo(java.lang.Object obj)` Compares this object with the specified object 'obj'.
`double`	`doubleValue()` Returns the value of this object as a double.
`boolean`	`equals(java.lang.Object obj)` Returns true if and only if the argument is not null and is a BooleanCp or Boolean object that represents the same boolean value as this object.
`float`	`floatValue()` Returns the value of this object as a float.
`java.lang.Boolean`	`getBooleanObj()` Returns the handle of the Boolean object held by this object.
`int`	`hashCode()` Returns a hash code for this BooleanCp object.
`int`	`intValue()` Returns the value of this object as an int.
`long`	`longValue()` Returns the value of this object as a long.
`short`	`shortValue()` Returns the value of this object as a short.
`java.lang.String`	`toString()` Returns a String object representing this BooleanCp's value.
`static BooleanCp`	`valueOf(boolean value)` Get a BooleanCp object representing the value argument.
`static BooleanCp`	`valueOf(java.lang.Boolean value)` Get a BooleanCp object representing the value argument.
`static BooleanCp`	`valueOf(java.lang.String str)` Get a BooleanCp object representing the value argument.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FALSE
```
public static final BooleanCp FALSE
```
    The BooleanCp object corresponding to the primitive value false.
  - TRUE
```
public static final BooleanCp TRUE
```
    The BooleanCp object corresponding to the primitive value true.
- Constructor Detail
  - BooleanCp
```
public BooleanCp(boolean value)
```
    Deprecated. 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 BooleanCp object representing the value argument.
    
    Parameters:
    
    value - the value of the BooleanCp.
  - BooleanCp
```
public BooleanCp(java.lang.Boolean bObj)
```
    Deprecated. 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 BooleanCp object which holds the given Boolean object.
    
    Parameters:
    
    bObj - the value of the BooleanCp.
  - BooleanCp
```
public BooleanCp(java.lang.String str)
```
    Deprecated. It is rarely appropriate to use this constructor. The static factory valueOf(String) 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 BooleanCp 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 BooleanCp("True") produces a BooleanCp object that represents true. new BooleanCp("yes") produces a BooleanCp object that represents false.
    
    Parameters:
    
    str - the string to be converted to a BooleanCp.
- Method Detail
  - valueOf
```
public static BooleanCp valueOf(boolean value)
```
    Get a BooleanCp object representing the value argument.
    
    Parameters:
    
    value - the value of the BooleanCp.
  - valueOf
```
public static BooleanCp valueOf(java.lang.Boolean value)
```
    Get a BooleanCp object representing the value argument.
    
    Parameters:
    
    value - the value of the BooleanCp.
  - valueOf
```
public static BooleanCp valueOf(java.lang.String str)
```
    Get a BooleanCp object representing the value argument.
    
    Parameters:
    
    str - the string to be converted to a BooleanCp.
  - booleanValue
```
public boolean booleanValue()
```
    Returns the value of this BooleanCp object as a boolean primitive.
    
    Returns:
    
    The primitive boolean value of this object.
  - byteValue
```
public byte byteValue()
```
    Returns the value of this object as a byte.
    
    Overrides:
    
    byteValue in class java.lang.Number
    
    Returns:
    
    byte value
  - compareTo
```
public int compareTo(java.lang.Object obj)
```
    Compares this object with the specified object 'obj'. 'false' is considered to be "less than" 'true'.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Parameters:
    
    obj - an object to compare to.
    
    Returns:
    
    A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Throws:
    
    java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this object as a double.
    
    Specified by:
    
    doubleValue in class java.lang.Number
    
    Returns:
    
    double value
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if and only if the argument is not null and is a BooleanCp or Boolean object that represents the same boolean value as this object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to compare with.
    
    Returns:
    
    true if the Boolean objects represent the same value; false otherwise.
  - floatValue
```
public float floatValue()
```
    Returns the value of this object as a float.
    
    Specified by:
    
    floatValue in class java.lang.Number
    
    Returns:
    
    float value
  - getBooleanObj
```
public java.lang.Boolean getBooleanObj()
```
    Returns the handle of the Boolean object held by this object.
    
    Returns:
    
    boolean object
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this BooleanCp object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The integer 1231 if this object represents true; returns the integer 1237 if this object represents false.
  - intValue
```
public int intValue()
```
    Returns the value of this object as an int.
    
    Specified by:
    
    intValue in class java.lang.Number
    
    Returns:
    
    integer value
  - longValue
```
public long longValue()
```
    Returns the value of this object as a long.
    
    Specified by:
    
    longValue in class java.lang.Number
    
    Returns:
    
    long value
  - shortValue
```
public short shortValue()
```
    Returns the value of this object as a short.
    
    Overrides:
    
    shortValue in class java.lang.Number
    
    Returns:
    
    short value
  - toString
```
public java.lang.String toString()
```
    Returns a String object representing this BooleanCp's value. If this object represents the value true, a string equal to "true" is returned. Otherwise, a string equal to "false" is returned.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.

Class BooleanCp

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FALSE

TRUE

Constructor Detail

BooleanCp

BooleanCp

BooleanCp

Method Detail

valueOf

valueOf

valueOf

booleanValue

byteValue

compareTo

doubleValue

equals

floatValue

getBooleanObj

hashCode

intValue

longValue

shortValue

toString