GsonResultObject (Data Model - Fluent Result 3.54.0 API)

java.lang.Object
- com.sap.cloud.sdk.result.GsonResultObject

All Implemented Interfaces:

ResultElement, ResultObject
```
public class GsonResultObject
extends Object
implements ResultObject
```
ResultObject implementation based on a JsonObject.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.google.gson.JsonObject`	`jsonObject` The underlying JSON object.
`protected GsonResultElementFactory`	`resultElementFactory` The `GsonResultElementFactory` to derive GSON builder from.

Constructor Summary

Constructors
Constructor and Description

GsonResultObject(com.google.gson.JsonObject jsonObject, GsonResultElementFactory resultElementFactory)

Constructors
Constructor and Description
`GsonResultObject(com.google.gson.JsonObject jsonObject, GsonResultElementFactory resultElementFactory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`as(Class<T> objectType)` Returns a value from this element.
`<T> T`	`as(Type objectType)` Returns this `ResultObject` casted into the given type `T`.
`BigDecimal`	`asBigDecimal()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `BigDecimal`.
`BigInteger`	`asBigInteger()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `BigInteger`.
`boolean`	`asBoolean()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `boolean`.
`byte`	`asByte()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `byte`.
`char`	`asCharacter()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `char`.
`double`	`asDouble()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `double`.
`float`	`asFloat()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `float`.
`int`	`asInteger()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `int`.
`long`	`asLong()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `long`.
`short`	`asShort()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `short`.
`String`	`asString()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `String`.
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`ResultElement`	`get(String elementName)` Returns the element with the given name from this result.
`ResultCollection`	`getAsCollection()` Returns this `ResultElement` as an instance of `ResultCollection`.
`ResultObject`	`getAsObject()` Returns this `ResultElement` as an instance of `ResultObject`.
`ResultPrimitive`	`getAsPrimitive()` Returns this `ResultElement` as an instance of `ResultPrimitive`.
`com.google.gson.JsonObject`	`getJsonObject()` The underlying JSON object.
`GsonResultElementFactory`	`getResultElementFactory()` The `GsonResultElementFactory` to derive GSON builder from.
`int`	`hashCode()`
`boolean`	`isResultCollection()` Checks whether this `ResultElement` represents a collection of result elements and, therefore, is a `ResultCollection`.
`boolean`	`isResultObject()` Checks whether this `ResultElement` represents a structured object and, therefore, is a `ResultObject`.
`boolean`	`isResultPrimitive()` Checks whether this `ResultElement` represents an unstructured value and, therefore, is a `ResultPrimitive`.
`String`	`toString()`

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

- Field Detail
  - jsonObject
```
protected final com.google.gson.JsonObject jsonObject
```
    The underlying JSON object.
  - resultElementFactory
```
protected final GsonResultElementFactory resultElementFactory
```
    The GsonResultElementFactory to derive GSON builder from.
- Constructor Detail
  - GsonResultObject
```
public GsonResultObject(com.google.gson.JsonObject jsonObject,
                        GsonResultElementFactory resultElementFactory)
```
- Method Detail
  - isResultPrimitive
```
public boolean isResultPrimitive()
```
    Checks whether this ResultElement represents an unstructured value and, therefore, is a ResultPrimitive.
    
    Specified by:
    
    isResultPrimitive in interface ResultElement
    
    Returns:
    
    True of this object is a ResultPrimitive, otherwise false.
  - isResultCollection
```
public boolean isResultCollection()
```
    Checks whether this ResultElement represents a collection of result elements and, therefore, is a ResultCollection.
    
    Specified by:
    
    isResultCollection in interface ResultElement
    
    Returns:
    
    True of this object is a ResultCollection, otherwise false.
  - isResultObject
```
public boolean isResultObject()
```
    Checks whether this ResultElement represents a structured object and, therefore, is a ResultObject.
    
    Specified by:
    
    isResultObject in interface ResultElement
    
    Returns:
    
    True of this object is a ResultObject, otherwise false.
  - getAsPrimitive
```
@Nonnull
public ResultPrimitive getAsPrimitive()
                                        throws UnsupportedOperationException
```
    Returns this ResultElement as an instance of ResultPrimitive.
    
    Specified by:
    
    getAsPrimitive in interface ResultElement
    
    Returns:
    
    An instance of ResultPrimitive.
    
    Throws:
    
    UnsupportedOperationException - If the cast into ResultPrimitive failed, e.g. in case it is not a primitive.
  - getAsCollection
```
@Nonnull
public ResultCollection getAsCollection()
                                          throws UnsupportedOperationException
```
    Returns this ResultElement as an instance of ResultCollection.
    
    Specified by:
    
    getAsCollection in interface ResultElement
    
    Returns:
    
    An instance of ResultCollection.
    
    Throws:
    
    UnsupportedOperationException - If the cast into ResultCollection failed, e.g. in case it is not a collection.
  - getAsObject
```
@Nonnull
public ResultObject getAsObject()
```
    Returns this ResultElement as an instance of ResultObject.
    
    Specified by:
    
    getAsObject in interface ResultElement
    
    Returns:
    
    An instance of ResultObject.
  - asBoolean
```
public boolean asBoolean()
                  throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as boolean.
    
    Specified by:
    
    asBoolean in interface ResultElement
    
    Returns:
    
    boolean value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as boolean.
  - asByte
```
public byte asByte()
            throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as byte.
    
    Specified by:
    
    asByte in interface ResultElement
    
    Returns:
    
    byte value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as byte.
  - asCharacter
```
public char asCharacter()
                 throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as char.
    
    Specified by:
    
    asCharacter in interface ResultElement
    
    Returns:
    
    char value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as char.
  - asString
```
@Nonnull
public String asString()
                         throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as String.
    
    Specified by:
    
    asString in interface ResultElement
    
    Returns:
    
    String object.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as String.
  - asInteger
```
public int asInteger()
              throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as int.
    
    Specified by:
    
    asInteger in interface ResultElement
    
    Returns:
    
    int value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as int.
  - asShort
```
public short asShort()
              throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as short.
    
    Specified by:
    
    asShort in interface ResultElement
    
    Returns:
    
    short value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as short.
  - asLong
```
public long asLong()
            throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as long.
    
    Specified by:
    
    asLong in interface ResultElement
    
    Returns:
    
    long value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as long.
  - asFloat
```
public float asFloat()
              throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as float.
    
    Specified by:
    
    asFloat in interface ResultElement
    
    Returns:
    
    float value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as float.
  - asDouble
```
public double asDouble()
                throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as double.
    
    Specified by:
    
    asDouble in interface ResultElement
    
    Returns:
    
    double value.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as double.
  - asBigInteger
```
@Nonnull
public BigInteger asBigInteger()
                                 throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as BigInteger.
    
    Specified by:
    
    asBigInteger in interface ResultElement
    
    Returns:
    
    BigInteger object.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as BigInteger.
  - asBigDecimal
```
@Nonnull
public BigDecimal asBigDecimal()
                                 throws UnsupportedOperationException
```
    In case this ResultElement is considered a ResultPrimitive, use this method to access its value as BigDecimal.
    
    Specified by:
    
    asBigDecimal in interface ResultElement
    
    Returns:
    
    BigDecimal object.
    
    Throws:
    
    UnsupportedOperationException - If this ResultElement is not considered a ResultPrimitive or its value cannot be represented as BigDecimal.
  - get
```
@Nullable
public ResultElement get(@Nonnull
                                   String elementName)
                            throws UnsupportedOperationException
```
    Returns the element with the given name from this result.
    
    Specified by:
    
    get in interface ResultObject
    
    Parameters:
    
    elementName - The name of the element to be accessed.
    
    Returns:
    
    An instance of GsonResultPrimitive representing the corresponding element.
    
    Throws:
    
    UnsupportedOperationException - If the element is not an instance of ResultObject.
  - as
```
@Nonnull
public <T> T as(@Nonnull
                         Class<T> objectType)
                  throws UnsupportedOperationException
```
    Returns a value from this element. The value is represented as an object of the given type.
    Important: In order to deserialize a result element to an object of a given type, you have to annotate all relevant field members of the respective class with ElementName. For example:
```
 class MyObject
 {
      @ElementName( "MANDT" )
     SapClient sapClient;
 }
 
 
```
    Specified by:
    
    as in interface ResultObject
    
    Type Parameters:
    
    T - The type the result object shall be casted to.
    
    Parameters:
    
    objectType - The type into which the element value should be converted.
    
    Returns:
    
    The value as object of type T.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be converted to the given type.
  - as
```
@Nonnull
public <T> T as(@Nonnull
                         Type objectType)
                  throws UnsupportedOperationException
```
    Description copied from interface: ResultObject
    
    Returns this ResultObject casted into the given type T.
    
    Specified by:
    
    as in interface ResultObject
    
    Type Parameters:
    
    T - The type the result object shall be casted to.
    
    Parameters:
    
    objectType - The Type of the type T
    
    Returns:
    
    An instance of T.
    
    Throws:
    
    UnsupportedOperationException - If the cast into the given object type failed.
  - getJsonObject
```
public com.google.gson.JsonObject getJsonObject()
```
    The underlying JSON object.
  - getResultElementFactory
```
public GsonResultElementFactory getResultElementFactory()
```
    The GsonResultElementFactory to derive GSON builder from.
  - equals
```
public boolean equals(@Nullable
                      Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(@Nullable
                           Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
@Nonnull
public String toString()
```
    Overrides:
    
    toString in class Object

Class GsonResultObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jsonObject

resultElementFactory

Constructor Detail

GsonResultObject

Method Detail

isResultPrimitive

isResultCollection

isResultObject

getAsPrimitive

getAsCollection

getAsObject

asBoolean

asByte

asCharacter

asString

asInteger

asShort

asLong

asFloat

asDouble

asBigInteger

asBigDecimal

get

as

as

getJsonObject

getResultElementFactory

equals

canEqual

hashCode

toString