com.atlassian.bitbucket.util

Class FilteredPageImpl<T>

java.lang.Object

com.atlassian.bitbucket.util.FilteredPageImpl<T>

Type Parameters:

T - type of the page

All Implemented Interfaces:

Page<T>

public class FilteredPageImpl<T>
extends Object
implements Page<T>

An instance of Page that supports pagination across an underlying paged collection.

Constructor Summary

Constructors

Constructor and Description
FilteredPageImpl(PageRequest pageRequest, int size, SortedMap<Integer,T> valueMap, boolean lastPage)

Method Summary

Modifier and Type	Method and Description
void	forEach(Consumer<? super T> action) Performs an action on each result in the page.
boolean	getIsLastPage()
int	getLimit()
PageRequest	getNextPageRequest()
SortedMap<Integer,T>	getOrdinalIndexedValues() Get a map of the page values mapped by their ordinal values.
int	getSize()
int	getStart()
Iterable<T>	getValues()
Stream<T>	stream()
<E> FilteredPageImpl<E>	transform(Function<? super T,? extends E> transformFunction) Transforms the results on the page, producing a new Page with different values but all other properties (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredPageImpl

public FilteredPageImpl(@Nonnull
                        PageRequest pageRequest,
                        int size,
                        @Nonnull
                        SortedMap<Integer,T> valueMap,
                        boolean lastPage)

Method Detail

forEach

public void forEach(@Nonnull
                    Consumer<? super T> action)

Description copied from interface: Page

Performs an action on each result in the page.

Specified by:

forEach in interface Page<T>

Parameters:

action - the action to apply to each result

Since:

6.3

getIsLastPage

public boolean getIsLastPage()

Specified by:

getIsLastPage in interface Page<T>

Returns:

true if there are no more results; otherwise, false if at least one more page, perhaps partially filled but not empty, of results is available

getLimit

public int getLimit()

Specified by:

getLimit in interface Page<T>

Returns:

the original limit on the PageRequest that generated this page

getNextPageRequest

public PageRequest getNextPageRequest()

Specified by:

getNextPageRequest in interface Page<T>

Returns:

a request which can be used to retrieve the next page, which will be null if this was the last page

getOrdinalIndexedValues

@Nonnull
public SortedMap<Integer,T> getOrdinalIndexedValues()

Description copied from interface: Page

Get a map of the page values mapped by their ordinal values. For filtered pages, the ordinals are the ordinals in the underlying paged collection.

Specified by:

getOrdinalIndexedValues in interface Page<T>

Returns:

values mapped by their ordinal value in the page

getSize

public int getSize()

Specified by:

getSize in interface Page<T>

Returns:

the number of results in the page

getStart

public int getStart()

Specified by:

getStart in interface Page<T>

Returns:

the offset into the overall result set the page starts at (0 based)

getValues

@Nonnull
public Iterable<T> getValues()

Specified by:

getValues in interface Page<T>

Returns:

the page's results

stream

@Nonnull
public Stream<T> stream()

Specified by:

stream in interface Page<T>

Returns:

a Stream over the page's results

transform

@Nonnull
public <E> FilteredPageImpl<E> transform(@Nonnull
                                                  Function<? super T,? extends E> transformFunction)

Description copied from interface: Page

Transforms the results on the page, producing a new Page with different values but all other properties (e.g. start and limit) unchanged.

Implementation note: Transformation is done eagerly to ensure the resulting Page does not retain a reference to the original results from the source page. If a transform is used purely to apply some set of side effects, consider using Page.forEach(java.util.function.Consumer<? super T>) instead.

Specified by:

transform in interface Page<T>

Type Parameters:

E - the target type

Parameters:

transformFunction - the transformer

Returns:

a new page with transformed results