CborSimple (CborTree 0.01.05-NEWM API)

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

```
public final class CborSimple
extends CborObject
```
CBOR simple value object class. This class is used for representing simple objects that have a major type of CborMajorType.OTHER and contain no additional data.
Untagged instances are always singletons, so you may directly compare known-untagged instances (like TRUE, NULL, etc,) to any other CborSimple instance using just the == operator. The equals(Object) method, of course, will also work, too.
On the other hand, tagged instances are not singletons. If you need to compare two unknown CborSimple objects then you must use equals(Object).

Field Summary

Fields
Modifier and Type	Field and Description
`static CborSimple`	`FALSE` CBOR simple value constant instance for "false".
`static CborSimple`	`NULL` CBOR simple value constant instance for "null".
`static CborSimple`	`TRUE` CBOR simple value constant instance for "true".
`static CborSimple`	`UNDEFINED` CBOR simple value constant instance for "undefined" values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CborSimple`	`copy()` Creates an independent, deep copy of this data item.
`static CborSimple`	`create(int value)` Method for obtaining an untagged singleton instance for "simple values" that contains no data.
`static CborSimple`	`create(int value, int tag)` Method for obtaining a tagged instance for "simple values" that contains no data.
`boolean`	`equals(Object obj)`
`int`	`getAdditionalInformation()` Returns the object's "additional information" value.
`int`	`getMajorType()` Returns the object's "Major Type", as defined by RFC7049.
`int`	`getTag()` Returns the tag for this object.
`int`	`getValue()` Returns the "simple value" associated with this object.
`int`	`hashCode()`
`boolean`	`isValidJson()` Indicates if this data item can be losslessly converted to a JSON fragment.
`@Nullable Object`	`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, toCborByteArray

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

- Field Detail
  - TRUE
```
public static final CborSimple TRUE
```
    CBOR simple value constant instance for "true".
  - FALSE
```
public static final CborSimple FALSE
```
    CBOR simple value constant instance for "false".
  - NULL
```
public static final CborSimple NULL
```
    CBOR simple value constant instance for "null".
  - UNDEFINED
```
public static final CborSimple UNDEFINED
```
    CBOR simple value constant instance for "undefined" values.
- Method Detail
  - create
```
public static CborSimple create(int value,
                                int tag)
```
    Method for obtaining a tagged instance for "simple values" that contains no data. If the specified tag is CborTag.UNTAGGED, then this method will return a singleton. Otherwise it will return a newly allocated instance.
    
    Parameters:
    
    value - the "simple value" of the desired singleton CborSimple object. Must be in the range of 0 to 255, inclusive.
    
    tag - the value of the tag
    
    Returns:
    
    a CborSimple object with the given value and tag.
    
    Throws:
    
    IllegalArgumentException - if value is out of range or if tag is invalid.
  - create
```
public static CborSimple create(int value)
```
    Method for obtaining an untagged singleton instance for "simple values" that contains no data.
    
    Parameters:
    
    value - the "simple value" of the desired singleton CborSimple object. Must be in the range of 0 to 255, inclusive. Note that values in the range of 24..31 are reserved and cannot be used.
    
    Returns:
    
    a singleton CborSimple object with the given value.
    
    Throws:
    
    IllegalArgumentException - if value is out of range or if it lies in the reserved range of 24..31.
  - 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()
  - getAdditionalInformation
```
public final int getAdditionalInformation()
```
    Description copied from class: CborObject
    
    Returns the object's "additional information" value. The meaning of this field is dependent on the major type. See RFC7049 section 2 for more information.
    
    Specified by:
    
    getAdditionalInformation in class CborObject
    
    See Also:
    
    CborObject.getMajorType()
  - getValue
```
public int getValue()
```
    Returns the "simple value" associated with this object.
  - getTag
```
public int getTag()
```
    Description copied from class: CborObject
    
    Returns the tag for this object.
    If the object is not tagged, returns CborTag.UNTAGGED.
    
    Overrides:
    
    getTag in class CborObject
    
    Returns:
    
    a number identifying the tag for this object, or CborTag.UNTAGGED if untagged.
    
    See Also:
    
    CborTag
  - copy
```
public CborSimple 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.
  - 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
  - toJavaObject
```
public @Nullable Object 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[]
    - TRUE/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 NULL or UNDEFINED.
    
    Throws:
    
    CborConversionException - if the underlying data item could not be represented as an instance of clazz.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public 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 final 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 CborSimple

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

TRUE

FALSE

NULL

UNDEFINED

Method Detail

create

create

getMajorType

getAdditionalInformation

getValue

getTag

copy

isValidJson

toJsonString

toJavaObject

toJavaObject

hashCode

equals

toString

toString