Package net.visma.autopay.http.structured

Class StructuredInnerList

java.lang.Object

net.visma.autopay.http.structured.StructuredItem

net.visma.autopay.http.structured.StructuredInnerList

All Implemented Interfaces:

StructuredCollection, StructuredField

public final class StructuredInnerList
extends StructuredItem
implements StructuredCollection

Class representing Structured Inner Lists

See Also:

• Inner Lists

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the specified object with this Structured Item for equality.
int	hashCode()	Returns hash code for this Structured Item.
<T extends StructuredItem> List<T>	itemList()	Returns List of Structured Items stored in this Structured List
static StructuredInnerList	of(Object... objects)	Creates Structured Inner List from given objects, without parameters for the inner list
static StructuredInnerList	of(Collection<?> objects)	Creates Structured Inner List from given Collection elements, without parameters for the inner list
static StructuredInnerList	withParams(Collection<?> objects, Map<String,?> parameters)	Creates Structured String of given object collection and parameters
static StructuredInnerList	withParams(Collection<?> objects, StructuredParameters parameters)	Creates Structured String of given object collection and parameters

Methods inherited from class net.visma.autopay.http.structured.StructuredItem

bigDecimalParam, boolParam, bytesParam, doubleParam, intParam, longParam, parameters, parse, serialize, stringParam, stringValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.visma.autopay.http.structured.StructuredCollection

bigDecimalList, boolList, bytesList, doubleList, intList, isEmpty, itemList, longList, stringList

Method Details

of

public static StructuredInnerList of(Collection<?> objects)

Creates Structured Inner List from given Collection elements, without parameters for the inner list

Provided objects are converted to Structured Items without parameters or used directly if they are instances of StructuredItem. Strings are converted to StructuredString. For tokens, use StructuredToken. For detailed conversion rules see StructuredList.of(Collection).

Parameters:

objects - Objects to be converted to StructuredInnerList items

Returns:

Created Structured Inner List

Throws:

IllegalArgumentException - Invalid objects provided

of

public static StructuredInnerList of(Object... objects)

Creates Structured Inner List from given objects, without parameters for the inner list

Provided objects are converted to Structured Items without parameters or used directly if they are instances of StructuredItem. Strings are converted to StructuredString. For tokens, use StructuredToken. For detailed conversion rules see StructuredList.of(Collection).

Parameters:

objects - Objects to be converted to StructuredInnerList items

Returns:

Created Structured Inner List

Throws:

IllegalArgumentException - Invalid objects provided

withParams

public static StructuredInnerList withParams(Collection<?> objects,
 Map<String,?> parameters)

Creates Structured String of given object collection and parameters

Parameters:

objects - Objects to be converted to StructuredInnerList items. For details, see of(Collection).

parameters - Parameter map. For details, check StructuredParameters.of(Map).

Returns:

Created Structured Inner List

Throws:

IllegalArgumentException - Invalid objects provided

withParams

public static StructuredInnerList withParams(Collection<?> objects,
 StructuredParameters parameters)

Creates Structured String of given object collection and parameters

Parameters:

objects - Objects to be converted to StructuredInnerList items. For details, see of(Collection).

parameters - Structured Parameter

Returns:

Created Structured Inner List

Throws:

IllegalArgumentException - Invalid objects provided

itemList

public <T extends StructuredItem> List<T> itemList()

Description copied from interface: StructuredCollection

Returns List of Structured Items stored in this Structured List

Specified by:

itemList in interface StructuredCollection

Type Parameters:

T - Specific Item class if needed. No type check is performed, only simple casting.

Returns:

Underlying list of StructuredItem objects

equals

public boolean equals(Object o)

Description copied from class: StructuredItem

Compares the specified object with this Structured Item for equality. Returns true if the given object is of the same class as this Item, it has the same value and properties.

Overrides:

equals in class StructuredItem

Parameters:

o - Object to be compared with this Structured Item

Returns:

True is specified object is equal to this Structured Item

hashCode

public int hashCode()

Description copied from class: StructuredItem

Returns hash code for this Structured Item. The hash code is a combination of hash codes of Item parameters and Item value.

Overrides:

hashCode in class StructuredItem

Returns:

The hash code for this Structured Item