Package net.visma.autopay.http.structured

Class StructuredList

java.lang.Object

net.visma.autopay.http.structured.StructuredList

All Implemented Interfaces:

StructuredCollection, StructuredField

public final class StructuredList
extends Object
implements StructuredField, StructuredCollection

Class representing Structured Lists

See Also:

• Lists

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the specified object with this Structured List for equality.
int	hashCode()	Returns hash code for this Structured List.
<T extends StructuredItem> List<T>	itemList()	Returns List of Structured Items stored in this Structured List
<T extends StructuredItem> List<List<T>>	listList()	Returns this list with Inner List values converted to List of StructuredItem objects.
static StructuredList	of(Object... objects)	Creates Structured List from given objects.
static StructuredList	of(Collection<?> objects)	Creates Structured List from given Collection elements.
static StructuredList	parse(String httpHeader)	Parses given string for Structured List, according to the specification
static StructuredList	parse(Collection<String> httpHeaders)	Parses given HTTP header values for Structured List, according to the specification
String	serialize()	Serializes this Structured List to a String, according to the specification.
String	toString()	Returns the string representation of this Structured List, which is the same as serialized representation.

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 StructuredList of(Collection<?> objects)

Creates Structured List from given Collection elements.

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 supported value types see the table below.

If collection element is a StructuredItem then it's used directly. Otherwise, the following conversion rules apply.

Conversion rules

Java class	StructuredItem class
Long Integer Short Byte	StructuredInteger
BigDecimal Double Float	StructuredDecimal
Boolean	StructuredBoolean
byte[]	StructuredBytes
String	StructuredString
Collection	StructuredInnerList
Enum	StructuredToken

Parameters:

objects - Collection to be converted to Structured List

Returns:

Created Structured List

Throws:

IllegalArgumentException - Invalid elements

of

public static StructuredList of(Object... objects)

Creates Structured List from given objects.

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 of(Collection).

Parameters:

objects - Objects to be converted to StructuredList items

Returns:

Created Structured 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

listList

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

Returns this list with Inner List values converted to List of StructuredItem objects. This list must contain StructuredInnerList values only.

Type Parameters:

T - Specific class of List members, if needed and the inner lists are homogenous

Returns:

List with values converted to List of StructuredItem

Throws:

ClassCastException - Thrown if this list contains non-StructuredInnerList values

serialize

public String serialize()

Serializes this Structured List to a String, according to the specification.

Specified by:

serialize in interface StructuredField

Returns:

Serialized representation of this Structured List

See Also:

• Serializing a List

parse

public static StructuredList parse(String httpHeader)
                            throws StructuredException

Parses given string for Structured List, according to the specification

Parameters:

httpHeader - String to parse, e.g. HTTP header

Returns:

Parsed Structured List

Throws:

StructuredException - Thrown in case of malformatted string or wrong item type

See Also:

• Parsing a List

parse

public static StructuredList parse(Collection<String> httpHeaders)
                            throws StructuredException

Parses given HTTP header values for Structured List, according to the specification

Parameters:

httpHeaders - HTTP header values, for common header name, provided in order of occurrence in HTTP message

Returns:

Parsed Structured List

Throws:

StructuredException - Thrown in case of malformatted string or wrong item type

See Also:

• Parsing a List

equals

public boolean equals(Object o)

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

Overrides:

equals in class Object

Parameters:

o - Object to be compared with this Structured List

Returns:

True is specified object is equal to this Structured List

hashCode

public int hashCode()

Returns hash code for this Structured List. The hash code is a combination of hash codes of List elements.

Overrides:

hashCode in class Object

Returns:

The hash code for this Structured List

toString

public String toString()

Returns the string representation of this Structured List, which is the same as serialized representation.

Overrides:

toString in class Object

Returns:

A string representation of this Structured List

See Also:

• serialize()