CborFloat (CborTree 0.01.05-NEWM API)

java.lang.Object
- com.google.iot.cbor.CborObject
- - com.google.iot.cbor.CborFloat

All Implemented Interfaces:

CborNumber
```
public abstract class CborFloat
extends CborObject
implements CborNumber
```
CBOR floating-point number object interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TYPE_DOUBLE` Value of the "additional information" field when contained value is an eight-byte double-float.
`static int`	`TYPE_FLOAT` Value of the "additional information" field when contained value is a four-byte float.
`static int`	`TYPE_HALF` Value of the "additional information" field when contained value is a two-byte half-float.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`BigInteger`	`bigIntegerValue()`
`CborFloat`	`copy()` Creates an independent, deep copy of this data item.
`static CborFloat`	`create(double value)` Creates an untagged `CborFloat` instance that will be encoded as an eight-byte double-float.
`static CborFloat`	`create(double value, int tag)` Creates a tagged `CborFloat` instance that will be encoded as a eight-byte double-float.
`static CborFloat`	`create(float value)` Creates an untagged `CborFloat` instance that will be encoded as a four-byte float.
`static CborFloat`	`create(float value, int tag)` Creates a tagged `CborFloat` instance that will be encoded as a four-byte float.
`static CborFloat`	`createHalf(float value)` Creates an untagged `CborFloat` instance that will be encoded as a two-byte half-float.
`static CborFloat`	`createHalf(float value, int tag)` Creates a tagged `CborFloat` instance that will be encoded as a two-byte half-float.
`abstract double`	`doubleValue()` Returns the value of this data item as a `double`.
`boolean`	`equals(Object obj)`
`abstract float`	`floatValue()` Returns the value of this data item as a `float`.
`int`	`getMajorType()` Returns the object's "Major Type", as defined by RFC7049.
`int`	`hashCode()`
`boolean`	`isValidJson()` Indicates if this data item can be losslessly converted to a JSON fragment.
`long`	`longValue()` Returns the value of the integer as a `long`.
`Number`	`toJavaObject()` Converts the given data item into a standard java object representation.
`<T> T`	`toJavaObject(Class<T> clazz)` Attempts to convert this data item to a java object with a specific class.
`String`	`toJsonString()` Returns a representation of this data item as JSON text.
`String`	`toString()` Describes this data item using CBOR diagnostic notation.
`String`	`toString(int ignore)` Describes this data item using CBOR diagnostic notation at the given indentation level.

Methods inherited from class com.google.iot.cbor.CborObject
createFromCborByteArray, createFromCborByteArray, createFromJavaObject, getAdditionalInformation, getTag, toCborByteArray

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

Methods inherited from interface com.google.iot.cbor.CborNumber
byteValueExact, intValueExact, shortValueExact

- Field Detail
  - TYPE_HALF
```
public static final int TYPE_HALF
```
    Value of the "additional information" field when contained value is a two-byte half-float.
    
    See Also:
    
    Constant Field Values
  - TYPE_FLOAT
```
public static final int TYPE_FLOAT
```
    Value of the "additional information" field when contained value is a four-byte float.
    
    See Also:
    
    Constant Field Values
  - TYPE_DOUBLE
```
public static final int TYPE_DOUBLE
```
    Value of the "additional information" field when contained value is an eight-byte double-float.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - createHalf
```
public static CborFloat createHalf(float value)
```
    Creates an untagged CborFloat instance that will be encoded as a two-byte half-float.
  - createHalf
```
public static CborFloat createHalf(float value,
                                   int tag)
```
    Creates a tagged CborFloat instance that will be encoded as a two-byte half-float.
  - create
```
public static CborFloat create(float value)
```
    Creates an untagged CborFloat instance that will be encoded as a four-byte float.
  - create
```
public static CborFloat create(float value,
                               int tag)
```
    Creates a tagged CborFloat instance that will be encoded as a four-byte float.
  - create
```
public static CborFloat create(double value)
```
    Creates an untagged CborFloat instance that will be encoded as an eight-byte double-float.
  - create
```
public static CborFloat create(double value,
                               int tag)
```
    Creates a tagged CborFloat instance that will be encoded as a eight-byte double-float.
  - floatValue
```
public abstract float floatValue()
```
    Description copied from interface: CborNumber
    
    Returns the value of this data item as a float.
    
    Specified by:
    
    floatValue in interface CborNumber
  - doubleValue
```
public abstract double doubleValue()
```
    Description copied from interface: CborNumber
    
    Returns the value of this data item as a double.
    
    Specified by:
    
    doubleValue in interface CborNumber
  - longValue
```
public final long longValue()
```
    Description copied from interface: CborNumber
    
    Returns the value of the integer as a long. If the underlying value is a floating point number, then the result is the floor of that value.
    
    Specified by:
    
    longValue in interface CborNumber
    
    Returns:
    
    The long value of this object.
  - bigIntegerValue
```
public final BigInteger bigIntegerValue()
```
    Specified by:
    
    bigIntegerValue in interface CborNumber
  - getMajorType
```
public final int getMajorType()
```
    Description copied from class: CborObject
    
    Returns the object's "Major Type", as defined by RFC7049. See RFC7049 section 2 for more information.
    
    Specified by:
    
    getMajorType in class CborObject
    
    See Also:
    
    CborMajorType, CborObject.getAdditionalInformation()
  - toJsonString
```
public final String toJsonString()
```
    Description copied from class: CborObject
    
    Returns a representation of this data item as JSON text.
    The result is guaranteed to be syntactically-valid RFC8259 JSON text. In the event that there is no JSON text representation for the underlying data item, its value will be replaced with a placeholder JSON value (usually "null"). This condition can be detected beforehand using CborObject.isValidJson().
    Note that, in some pre-RFC8259 contexts, this method could be described as returning a "JSON fragment" unless the data item was of the types CborMap (for a JSON object) or CborArray (for a JSON array).
    
    Specified by:
    
    toJsonString in class CborObject
    
    Returns:
    
    a String containing representation of this data item as JSON text
    
    See Also:
    
    CborObject.isValidJson(), RFC8259
  - copy
```
public final CborFloat copy()
```
    Description copied from class: CborObject
    
    Creates an independent, deep copy of this data item. If the object that is being copied is immutable, this method may simple return a reference to the object.
    
    Specified by:
    
    copy in class CborObject
    
    Returns:
    
    new CborObject
  - isValidJson
```
public final boolean isValidJson()
```
    Description copied from class: CborObject
    
    Indicates if this data item can be losslessly converted to a JSON fragment.
    Note that, with few exceptions, tags are not considered in this determination, since CborObject.toJsonString() will strip out tags anyway.
    
    Specified by:
    
    isValidJson in class CborObject
    
    Returns:
    
    true if this object could be rendered as JSON, false otherwise.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toJavaObject
```
public Number toJavaObject()
```
    Description copied from class: CborObject
    Converts the given data item into a standard java object representation.
    Tags are largely ignored, except in cases where the tag itself has defined behavior when converting to JSON, like CborTag.EXPECTED_BASE16 and CborTag.EXPECTED_BASE64.
    The resulting object type is dependent on the data item:
    - CborMap → Map<Object,Object>
    - CborArray → Collection<Object>
    - CborFloat → Float/Double
    - CborInteger → Integer/Long
    - CborTextString → String
    - CborByteString → byte[]
    - CborSimple.TRUE/CborSimple.FALSE → Boolean
    - Other CborSimple values → null
    The returned value is a wholly independent copy.
    Specified by:
    
    toJavaObject in class CborObject
    
    See Also:
    
    CborObject.createFromJavaObject(Object)
  - toJavaObject
```
public <T> T toJavaObject(Class<T> clazz)
                   throws CborConversionException
```
    Description copied from class: CborObject
    Attempts to convert this data item to a java object with a specific class.
    Unlike CborObject.toJavaObject(), this method will introspect into tags to figure out conversions to BigInteger and URI. Unknown tags are ignored.
    This method will return the most expressive result that satisfies the clazz parameter. For example, if the data item is a CborByteString tagged CborTag.BIGNUM_POS, calling this method with different classes will lead to different results:
    - toJavaObject(byte[].class would return a byte[]
    - toJavaObject(Object.class would return a BigInteger
    - toJavaObject(BigInteger.class would return a BigInteger
    - toJavaObject(URI.class would throw CborConversionException
    Whereas this method called an untagged CborByteString would behave like this:
    - toJavaObject(byte[].class would return a byte[]
    - toJavaObject(Object.class would return a byte[]
    - toJavaObject(BigInteger.class would throw CborConversionException
    - toJavaObject(URI.class would throw CborConversionException
    Specified by:
    
    toJavaObject in class CborObject
    
    Parameters:
    
    clazz - The desired class of the returned object
    
    Returns:
    
    a reference to an object of class clazz or null if this data item was CborSimple.NULL or CborSimple.UNDEFINED.
    
    Throws:
    
    CborConversionException - if the underlying data item could not be represented as an instance of clazz.
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString(int ignore)
```
    Description copied from class: CborObject
    
    Describes this data item using CBOR diagnostic notation at the given indentation level.
    The output is similar to that of CborObject.toJsonString() except that it also includes tag and encoding information that is CBOR-specific.
    The returned string is intended as a diagnostic aid and not intended to be machine-readable.
    
    Specified by:
    
    toString in class CborObject
    
    Parameters:
    
    ignore - the indentation level of the string to output. A negative value indicates no newlines or whitespace should be added.
    
    Returns:
    
    a String describing the data item.
    
    See Also:
    
    CBOR Diagnostic Notation, CborObject.toString()
  - toString
```
public String toString()
```
    Description copied from class: CborObject
    
    Describes this data item using CBOR diagnostic notation.
    No additional whitespace is added for readability.
    The output is similar to that of CborObject.toJsonString() except that it also includes tag and encoding information that is CBOR-specific.
    The returned string is intended as a diagnostic aid and not intended to be machine-readable.
    
    Overrides:
    
    toString in class CborObject
    
    Returns:
    
    a String describing the data item.
    
    See Also:
    
    CBOR Diagnostic Notation, CborObject.toString(int)

Class CborFloat

Field Summary

Method Summary

Methods inherited from class com.google.iot.cbor.CborObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.iot.cbor.CborNumber

Field Detail

TYPE_HALF

TYPE_FLOAT

TYPE_DOUBLE

Method Detail

createHalf

createHalf

create

create

create

create

floatValue

doubleValue

longValue

bigIntegerValue

getMajorType

toJsonString

copy

isValidJson

hashCode

toJavaObject

toJavaObject

equals

toString

toString