com.yahoo.elide.jsonapi.models

Class Data<T>

java.lang.Object

com.yahoo.elide.jsonapi.models.Data<T>

Type Parameters:

T - type

public class Data<T>
extends Object

Container for different representations of top-level data in JSON API.

Constructor Summary

Constructors

Constructor and Description
Data(Collection<T> values) Constructor.
Data(Collection<T> values, RelationshipType relationshipType) Constructor.
Data(io.reactivex.Observable<T> values) Constructor.
Data(io.reactivex.Observable<T> values, RelationshipType relationshipType) Constructor.
Data(T value) Constructor.

Method Summary

Modifier and Type	Method and Description
Collection<T>	get()
T	getSingleValue() Fetch the item if the data is toOne.
boolean	isToOne() Determine whether or not the contained type is toOne.
void	sort(Comparator<T> sortFunction) Sort method using provided sort function.
Collection<ResourceIdentifier>	toResourceIdentifiers()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Data

public Data(T value)

Constructor.

Parameters:

value - singleton resource

Data

public Data(io.reactivex.Observable<T> values)

Constructor.

Parameters:

values - List of resources

Data

public Data(io.reactivex.Observable<T> values,
            RelationshipType relationshipType)

Constructor.

Parameters:

values - List of resources

relationshipType - toOne or toMany

Data

public Data(Collection<T> values)

Constructor.

Parameters:

values - List of resources

Data

public Data(Collection<T> values,
            RelationshipType relationshipType)

Constructor.

Parameters:

values - List of resources

relationshipType - toOne or toMany

Method Detail

sort

public void sort(Comparator<T> sortFunction)

Sort method using provided sort function.

Parameters:

sortFunction - comparator to sort data with

get

public Collection<T> get()

isToOne

public boolean isToOne()

Determine whether or not the contained type is toOne.

Returns:

True if toOne, false if toMany

getSingleValue

public T getSingleValue()

Fetch the item if the data is toOne.

Returns:

T if toOne

Throws:

IllegalAccessError - when the data is not toOne

toResourceIdentifiers

public Collection<ResourceIdentifier> toResourceIdentifiers()