DefaultResultCollection (SAP S/4HANA Cloud SDK

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

All Implemented Interfaces:

ResultCollection, ResultElement, Iterable<ResultElement>
```
public class DefaultResultCollection
extends Object
implements ResultCollection
```
This class provides an abstraction of a collection of result elements

Constructor Summary

Constructors
Constructor and Description

DefaultResultCollection(Iterable<ResultElement> resultElements)

Constructors
Constructor and Description
`DefaultResultCollection(Iterable<ResultElement> resultElements)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigDecimal`	`asBigDecimal()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `BigDecimal`.
`List<BigDecimal>`	`asBigDecimalList()` Returns a list of values from this instance.
`Set<BigDecimal>`	`asBigDecimalSet()` Returns a set of values from this instance.
`BigInteger`	`asBigInteger()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `BigInteger`.
`List<BigInteger>`	`asBigIntegerList()` Returns a list of values from this instance.
`Set<BigInteger>`	`asBigIntegerSet()` Returns a set of values from this instance.
`boolean`	`asBoolean()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `boolean`.
`List<Boolean>`	`asBooleanList()` Returns a list of values from this instance.
`Set<Boolean>`	`asBooleanSet()` Returns a set of values from this instance.
`byte`	`asByte()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `byte`.
`List<Byte>`	`asByteList()` Returns a list of values from this instance.
`Set<Byte>`	`asByteSet()` Returns a set of values from this instance.
`char`	`asCharacter()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `char`.
`List<Character>`	`asCharacterList()` Returns a list of values from this instance.
`Set<Character>`	`asCharacterSet()` Returns a set of values from this instance.
`double`	`asDouble()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `double`.
`List<Double>`	`asDoubleList()` Returns a list of values from this instance.
`Set<Double>`	`asDoubleSet()` Returns a set of values from this instance.
`float`	`asFloat()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `float`.
`List<Float>`	`asFloatList()` Returns a list of values from this instance.
`Set<Float>`	`asFloatSet()` Returns a set of values from this instance.
`int`	`asInteger()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `int`.
`List<Integer>`	`asIntegerList()` Returns a list of values from this instance.
`Set<Integer>`	`asIntegerSet()` Returns a set of values from this instance.
`<T> List<T>`	`asList(Class<T> objectType)` Returns a list of values from this instance.
`long`	`asLong()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `long`.
`List<Long>`	`asLongList()` Returns a list of values from this instance.
`Set<Long>`	`asLongSet()` Returns a set of values from this instance.
`<T> Set<T>`	`asSet(Class<T> objectType)` Returns a set of values from this instance.
`short`	`asShort()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `short`.
`List<Short>`	`asShortList()` Returns a list of values from this instance.
`Set<Short>`	`asShortSet()` Returns a set of values from this instance.
`String`	`asString()` In case this `ResultElement` is considered a `ResultPrimitive`, use this method to access its value as `String`.
`List<String>`	`asStringList()` Returns a list of values from this instance.
`Set<String>`	`asStringSet()` Returns a set of values from this instance.
`CollectedResultCollection`	`collect(String elementName)` Collects elements inside this `ResultCollection` identified by `filterName` and returns a `CollectedResultCollection` that contains only the collected elements.
`boolean`	`equals(Object o)`
`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`.
`Iterable<ResultElement>`	`getResultElements()`
`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`.
`Iterator<ResultElement>`	`iterator()`
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - DefaultResultCollection
```
public DefaultResultCollection(Iterable<ResultElement> resultElements)
```
- Method Detail
  - collect
```
public CollectedResultCollection collect(String elementName)
```
    Description copied from interface: ResultCollection
    
    Collects elements inside this ResultCollection identified by filterName and returns a CollectedResultCollection that contains only the collected elements.
    
    Specified by:
    
    collect in interface ResultCollection
    
    Parameters:
    
    elementName - The name used to identify the items to collect
    
    Returns:
    
    Instance of CollectedResultCollection that contains only the collected elements.
  - asList
```
public <T> List<T> asList(Class<T> objectType)
                   throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are 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:
    
    asList in interface ResultCollection
    
    Type Parameters:
    
    T - The type the elements in this collection object shall be casted to
    
    Parameters:
    
    objectType - The type into which the values should be converted.
    
    Returns:
    
    The list of values as objects of type T.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asSet
```
public <T> Set<T> asSet(Class<T> objectType)
                 throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are 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:
    
    asSet in interface ResultCollection
    
    Type Parameters:
    
    T - The type the elements in this collection object shall be casted to
    
    Parameters:
    
    objectType - The type into which the values should be converted.
    
    Returns:
    
    The set of values as objects of type T.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asBooleanList
```
public List<Boolean> asBooleanList()
                            throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Boolean.
    
    Specified by:
    
    asBooleanList in interface ResultCollection
    
    Returns:
    
    The list of values as Boolean.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asBooleanSet
```
public Set<Boolean> asBooleanSet()
                          throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Boolean.
    
    Specified by:
    
    asBooleanSet in interface ResultCollection
    
    Returns:
    
    The set of values as Boolean.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asByteList
```
public List<Byte> asByteList()
                      throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Byte.
    
    Specified by:
    
    asByteList in interface ResultCollection
    
    Returns:
    
    The list of values as Byte.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asByteSet
```
public Set<Byte> asByteSet()
                    throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Byte.
    
    Specified by:
    
    asByteSet in interface ResultCollection
    
    Returns:
    
    The set of values as Byte.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asCharacterList
```
public List<Character> asCharacterList()
                                throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Character.
    
    Specified by:
    
    asCharacterList in interface ResultCollection
    
    Returns:
    
    The list of values as Character.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asCharacterSet
```
public Set<Character> asCharacterSet()
                              throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Character.
    
    Specified by:
    
    asCharacterSet in interface ResultCollection
    
    Returns:
    
    The set of values as Character.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asStringList
```
public List<String> asStringList()
                          throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as String.
    
    Specified by:
    
    asStringList in interface ResultCollection
    
    Returns:
    
    The list of values as String.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asStringSet
```
public Set<String> asStringSet()
                        throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as String.
    
    Specified by:
    
    asStringSet in interface ResultCollection
    
    Returns:
    
    The set of values as String.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asIntegerList
```
public List<Integer> asIntegerList()
                            throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Integer.
    
    Specified by:
    
    asIntegerList in interface ResultCollection
    
    Returns:
    
    The list of values as Integer.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asIntegerSet
```
public Set<Integer> asIntegerSet()
                          throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Integer.
    
    Specified by:
    
    asIntegerSet in interface ResultCollection
    
    Returns:
    
    The set of values as Integer.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asShortList
```
public List<Short> asShortList()
                        throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Short.
    
    Specified by:
    
    asShortList in interface ResultCollection
    
    Returns:
    
    The list of values as Short.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asShortSet
```
public Set<Short> asShortSet()
                      throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Short.
    
    Specified by:
    
    asShortSet in interface ResultCollection
    
    Returns:
    
    The set of values as Short.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asLongList
```
public List<Long> asLongList()
                      throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Long.
    
    Specified by:
    
    asLongList in interface ResultCollection
    
    Returns:
    
    The list of values as Long.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asLongSet
```
public Set<Long> asLongSet()
                    throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Long.
    
    Specified by:
    
    asLongSet in interface ResultCollection
    
    Returns:
    
    The set of values as Long.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asFloatList
```
public List<Float> asFloatList()
                        throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Float.
    
    Specified by:
    
    asFloatList in interface ResultCollection
    
    Returns:
    
    The list of values as Float.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asFloatSet
```
public Set<Float> asFloatSet()
                      throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Float.
    
    Specified by:
    
    asFloatSet in interface ResultCollection
    
    Returns:
    
    The set of values as Float.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asDoubleList
```
public List<Double> asDoubleList()
                          throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as Double.
    
    Specified by:
    
    asDoubleList in interface ResultCollection
    
    Returns:
    
    The list of values as Double.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asDoubleSet
```
public Set<Double> asDoubleSet()
                        throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as Double.
    
    Specified by:
    
    asDoubleSet in interface ResultCollection
    
    Returns:
    
    The set of values as Double.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asBigIntegerList
```
public List<BigInteger> asBigIntegerList()
                                  throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as BigInteger.
    
    Specified by:
    
    asBigIntegerList in interface ResultCollection
    
    Returns:
    
    The list of values as BigInteger.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asBigIntegerSet
```
public Set<BigInteger> asBigIntegerSet()
                                throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as BigInteger.
    
    Specified by:
    
    asBigIntegerSet in interface ResultCollection
    
    Returns:
    
    The set of values as BigInteger.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asBigDecimalList
```
public List<BigDecimal> asBigDecimalList()
                                  throws UnsupportedOperationException
```
    Returns a list of values from this instance. The values are represented as BigDecimal.
    
    Specified by:
    
    asBigDecimalList in interface ResultCollection
    
    Returns:
    
    The list of values as BigDecimal.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - asBigDecimalSet
```
public Set<BigDecimal> asBigDecimalSet()
                                throws UnsupportedOperationException
```
    Returns a set of values from this instance. The values are represented as BigDecimal.
    
    Specified by:
    
    asBigDecimalSet in interface ResultCollection
    
    Returns:
    
    The set of values as BigDecimal.
    
    Throws:
    
    UnsupportedOperationException - If the value could not be found or could not be converted to the given type.
  - isResultPrimitive
```
public boolean isResultPrimitive()
```
    Description copied from interface: ResultElement
    
    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()
```
    Description copied from interface: ResultElement
    
    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()
```
    Description copied from interface: ResultElement
    
    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
```
public ResultPrimitive getAsPrimitive()
                               throws UnsupportedOperationException
```
    Description copied from interface: ResultElement
    
    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
```
public ResultCollection getAsCollection()
```
    Description copied from interface: ResultElement
    
    Returns this ResultElement as an instance of ResultCollection.
    
    Specified by:
    
    getAsCollection in interface ResultElement
    
    Returns:
    
    An instance of ResultCollection
  - getAsObject
```
public ResultObject getAsObject()
                         throws UnsupportedOperationException
```
    Description copied from interface: ResultElement
    
    Returns this ResultElement as an instance of ResultObject.
    
    Specified by:
    
    getAsObject in interface ResultElement
    
    Returns:
    
    An instance of ResultObject
    
    Throws:
    
    UnsupportedOperationException - If the cast into ResultObject failed, e.g. in case it is not an object
  - asBoolean
```
public boolean asBoolean()
                  throws UnsupportedOperationException
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
public String asString()
                throws UnsupportedOperationException
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
    Description copied from interface: ResultElement
    
    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
```
public BigInteger asBigInteger()
                        throws UnsupportedOperationException
```
    Description copied from interface: ResultElement
    
    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
```
public BigDecimal asBigDecimal()
                        throws UnsupportedOperationException
```
    Description copied from interface: ResultElement
    
    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
  - iterator
```
public Iterator<ResultElement> iterator()
```
    Specified by:
    
    iterator in interface Iterable<ResultElement>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getResultElements
```
public Iterable<ResultElement> getResultElements()
```

Class DefaultResultCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

DefaultResultCollection

Method Detail

collect

asList

asSet

asBooleanList

asBooleanSet

asByteList

asByteSet

asCharacterList

asCharacterSet

asStringList

asStringSet

asIntegerList

asIntegerSet

asShortList

asShortSet

asLongList

asLongSet

asFloatList

asFloatSet

asDoubleList

asDoubleSet

asBigIntegerList

asBigIntegerSet

asBigDecimalList

asBigDecimalSet

isResultPrimitive

isResultCollection

isResultObject

getAsPrimitive

getAsCollection

getAsObject

asBoolean

asByte

asCharacter

asString

asInteger

asShort

asLong

asFloat

asDouble

asBigInteger

asBigDecimal

iterator

equals

hashCode

toString

getResultElements