Package com.github.davidmoten.odata.client

Class CollectionPageEntityRequest<T extends ODataEntityType,R extends EntityRequest<T>>

java.lang.Object

com.github.davidmoten.odata.client.CollectionPageEntityRequest<T,R>

All Implemented Interfaces:

Iterable<T>

public class CollectionPageEntityRequest<T extends ODataEntityType,R extends EntityRequest<T>>
extends Object
implements Iterable<T>

Constructor Summary

Constructors

Constructor	Description
CollectionPageEntityRequest(ContextPath contextPath, Class<T> cls, EntityRequestFactory<T,R> entityRequestFactory, Optional<Object> value)

Method Summary

Modifier and Type	Method	Description
CollectionEntityRequestOptionsBuilder<T,R>	connectTimeout(long duration, TimeUnit unit)
CollectionEntityRequestOptionsBuilder<T,R>	deltaTokenLatest()
CollectionEntityRequestOptionsBuilder<T,R>	expand(String clause)
<S extends T> CollectionPageEntityRequest<S,EntityRequest<S>>	filter(Class<S> cls)	Returns a request for only those members of the collection that are of the requested type.
CollectionEntityRequestOptionsBuilder<T,R>	filter(String clause)
CollectionPage<T>	get()
R	id(Object id)
Iterator<T>	iterator()
CollectionEntityRequestOptionsBuilder<T,R>	maxPageSize(int size)
CollectionEntityRequestOptionsBuilder<T,R>	metadataFull()
CollectionEntityRequestOptionsBuilder<T,R>	metadataMinimal()
CollectionEntityRequestOptionsBuilder<T,R>	metadataNone()
CollectionEntityRequestOptionsBuilder<T,R>	orderBy(String clause)
Optional<T>	patch(T entity)
Optional<T>	post(T entity)
CollectionEntityRequestOptionsBuilder<T,R>	query(String name, String value)
CollectionEntityRequestOptionsBuilder<T,R>	readTimeout(long duration, TimeUnit unit)
CollectionEntityRequestOptionsBuilder<T,R>	requestHeader(RequestHeader header)
CollectionEntityRequestOptionsBuilder<T,R>	requestHeader(String key, String value)
CollectionEntityRequestOptionsBuilder<T,R>	search(String clause)
CollectionEntityRequestOptionsBuilder<T,R>	select(String clause)
CollectionEntityRequestOptionsBuilder<T,R>	skip(long n)
Stream<T>	stream()
Stream<ObjectOrDeltaLink<T>>	streamWithDeltaLink()
<S> S	to(Function<? super CollectionPage<T>,? extends S> function)
List<T>	toList()
CollectionEntityRequestOptionsBuilder<T,R>	top(long n)
CollectionEntityRequestOptionsBuilder<T,R>	urlOverride(String urlOverride)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CollectionPageEntityRequest

public CollectionPageEntityRequest(ContextPath contextPath,
                                   Class<T> cls,
                                   EntityRequestFactory<T,R> entityRequestFactory,
                                   Optional<Object> value)

Method Detail

id

public R id(Object id)

get

public CollectionPage<T> get()

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends ODataEntityType>

stream

public Stream<T> stream()

streamWithDeltaLink

public Stream<ObjectOrDeltaLink<T>> streamWithDeltaLink()

to

public <S> S to(Function<? super CollectionPage<T>,? extends S> function)

toList

public List<T> toList()

post

public Optional<T> post(T entity)

patch

public Optional<T> patch(T entity)

filter

public <S extends T> CollectionPageEntityRequest<S,EntityRequest<S>> filter(Class<S> cls)

Returns a request for only those members of the collection that are of the requested type. This is referred to in the OData 4.01 specification as a "restriction to instances of the derived type".

Type Parameters:

S - the type ("derived type") to be restricting to

Parameters:

cls - the Class of the type to restrict to

Returns:

a request for a collection of instances with the given type

requestHeader

public CollectionEntityRequestOptionsBuilder<T,R> requestHeader(String key,
                                                                      String value)

query

public CollectionEntityRequestOptionsBuilder<T,R> query(String name,
                                                              String value)

requestHeader

public CollectionEntityRequestOptionsBuilder<T,R> requestHeader(RequestHeader header)

maxPageSize

public CollectionEntityRequestOptionsBuilder<T,R> maxPageSize(int size)

search

public CollectionEntityRequestOptionsBuilder<T,R> search(String clause)

expand

public CollectionEntityRequestOptionsBuilder<T,R> expand(String clause)

filter

public CollectionEntityRequestOptionsBuilder<T,R> filter(String clause)

orderBy

public CollectionEntityRequestOptionsBuilder<T,R> orderBy(String clause)

skip

public CollectionEntityRequestOptionsBuilder<T,R> skip(long n)

top

public CollectionEntityRequestOptionsBuilder<T,R> top(long n)

select

public CollectionEntityRequestOptionsBuilder<T,R> select(String clause)

metadataFull

public CollectionEntityRequestOptionsBuilder<T,R> metadataFull()

metadataMinimal

public CollectionEntityRequestOptionsBuilder<T,R> metadataMinimal()

metadataNone

public CollectionEntityRequestOptionsBuilder<T,R> metadataNone()

urlOverride

public CollectionEntityRequestOptionsBuilder<T,R> urlOverride(String urlOverride)

connectTimeout

public CollectionEntityRequestOptionsBuilder<T,R> connectTimeout(long duration,
                                                                       TimeUnit unit)

readTimeout

public CollectionEntityRequestOptionsBuilder<T,R> readTimeout(long duration,
                                                                    TimeUnit unit)

deltaTokenLatest

public CollectionEntityRequestOptionsBuilder<T,R> deltaTokenLatest()