com.cerner.beadledom.pagination

Class OffsetPaginatedList.Builder<T>

java.lang.Object

com.cerner.beadledom.pagination.OffsetPaginatedList.Builder<T>

Enclosing class:

OffsetPaginatedList<T>

public abstract static class OffsetPaginatedList.Builder<T>
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OffsetPaginatedList<T>	build() Builds a new instance of OffsetPaginatedList.
abstract OffsetPaginatedList.Builder<T>	items(List<T> items)
OffsetPaginatedList.Builder<T>	metadata(Integer limit, Long offset, Long totalResults, Boolean hasMore) Deprecated. use metadata(OffsetPaginatedListMetadata), possibly with a builder instead
OffsetPaginatedList.Builder<T>	metadata(Long totalResults) Deprecated. use totalResults(Long) instead
abstract OffsetPaginatedList.Builder<T>	metadata(OffsetPaginatedListMetadata metadata)
OffsetPaginatedList.Builder<T>	metadata(String limitFieldName, Integer limit, String offsetFieldName, Long offset, Long totalResults, Boolean hasMore) Deprecated. use metadata(OffsetPaginatedListMetadata), possibly with a builder instead
OffsetPaginatedList.Builder<T>	totalResults(Long totalResults) Convenience method that adds a metadata instance with total results and default field names without having to manually build an OffsetPaginatedListMetadata object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

items

public abstract OffsetPaginatedList.Builder<T> items(List<T> items)

metadata

public abstract OffsetPaginatedList.Builder<T> metadata(OffsetPaginatedListMetadata metadata)

metadata

@Deprecated
public OffsetPaginatedList.Builder<T> metadata(@Nullable
                                                           String limitFieldName,
                                                           @Nullable
                                                           Integer limit,
                                                           @Nullable
                                                           String offsetFieldName,
                                                           @Nullable
                                                           Long offset,
                                                           @Nullable
                                                           Long totalResults,
                                                           @Nullable
                                                           Boolean hasMore)

Deprecated. use metadata(OffsetPaginatedListMetadata), possibly with a builder instead

Convenience method that allows metadata to be set without having to manually build a OffsetPaginatedListMetadata object.

Parameters:

limitFieldName - the limit field name used to create the page

limit - the limit used to create the page

offsetFieldName - the offset field name used to create the page

offset - the offset used to create the page

totalResults - the total results available

hasMore - indicates if there are more results available

Returns:

The OffsetPaginatedList.Builder being used for the OffsetPaginatedList

metadata

@Deprecated
public OffsetPaginatedList.Builder<T> metadata(@Nullable
                                                           Integer limit,
                                                           @Nullable
                                                           Long offset,
                                                           @Nullable
                                                           Long totalResults,
                                                           @Nullable
                                                           Boolean hasMore)

Deprecated. use metadata(OffsetPaginatedListMetadata), possibly with a builder instead

Convenience method that allows metadata to be set using configured field names without having to manually build a OffsetPaginatedListMetadata object.

Parameters:

limit - the limit used to create the page

offset - the offset used to create the page

totalResults - the total results available

hasMore - indicates if there are more results available

Returns:

The OffsetPaginatedList.Builder being used for the OffsetPaginatedList

metadata

@Deprecated
public OffsetPaginatedList.Builder<T> metadata(@Nullable
                                                           Long totalResults)

Deprecated. use totalResults(Long) instead

Convenience method that creates metadata with total results and default field names without having to manually build a OffsetPaginatedListMetadata object.

Parameters:

totalResults - the total results available

Returns:

the OffsetPaginatedList.Builder being used for the OffsetPaginatedList

totalResults

public OffsetPaginatedList.Builder<T> totalResults(@Nullable
                                                   Long totalResults)

Convenience method that adds a metadata instance with total results and default field names without having to manually build an OffsetPaginatedListMetadata object.

Parameters:

totalResults - the total results available

Returns:

the OffsetPaginatedList.Builder being used for the OffsetPaginatedList

build

public OffsetPaginatedList<T> build()

Builds a new instance of OffsetPaginatedList.