CborTextString (CborTree 0.01.05-NEWM API)

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

public abstract class CborTextString
extends CborObject

CBOR text string object interface.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract byte[][]`	`byteArrayValue()`
`CborTextString`	`copy()` Creates an independent, deep copy of this data item.
`static CborTextString`	`create(byte[] array)`
`static CborTextString`	`create(byte[][] arrays, int[] offsets, int[] lengths, int tag, boolean isIndefiniteLength)`
`static CborTextString`	`create(byte[] array, int offset, int length)`
`static CborTextString`	`create(byte[] array, int offset, int length, int tag, boolean isIndefiniteLength)`
`static CborTextString`	`create(String string)`
`static CborTextString`	`create(String string, int tag)`
`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`	`hashCode()`
`abstract boolean`	`isIndefiniteLength()`
`boolean`	`isValidJson()` Indicates if this data item can be losslessly converted to a JSON fragment.
`abstract String`	`stringValue()`
`String`	`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, getTag, toCborByteArray

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

- Method Detail
  - create
```
public static CborTextString create(byte[][] arrays,
                                    int[] offsets,
                                    int[] lengths,
                                    int tag,
                                    boolean isIndefiniteLength)
```
  - create
```
public static CborTextString create(byte[] array,
                                    int offset,
                                    int length,
                                    int tag,
                                    boolean isIndefiniteLength)
```
  - create
```
public static CborTextString create(byte[] array,
                                    int offset,
                                    int length)
```
  - create
```
public static CborTextString create(byte[] array)
```
  - create
```
public static CborTextString create(String string,
                                    int tag)
```
  - create
```
public static CborTextString create(String string)
```
  - stringValue
```
public abstract String stringValue()
```
  - byteArrayValue
```
public abstract byte[][] byteArrayValue()
```
  - 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 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()
  - isIndefiniteLength
```
public abstract boolean isIndefiniteLength()
```
  - 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.
  - copy
```
public CborTextString 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
  - 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 String 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.
  - 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 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 CborTextString

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

create

create

create

create

create

create

stringValue

byteArrayValue

getMajorType

getAdditionalInformation

isIndefiniteLength

isValidJson

copy

toJsonString

toJavaObject

toJavaObject

hashCode

equals

toString

toString