Spring Data Core

org.springframework.data.domain
Interface Slice<T>

All Superinterfaces:
Iterable<T>
All Known Subinterfaces:
Page<T>
All Known Implementing Classes:
GeoPage, PageImpl, SliceImpl

public interface Slice<T>
extends Iterable<T>

A slice of data that indicates whether there's a next or previous slice available. Allows to obtain a Pageable to request a previous or next Slice.

Since:
1.8
Author:
Oliver Gierke

Method Summary
 List<T> getContent()
          Returns the page content as List.
 int getNumber()
          Returns the number of the current Slice.
 int getNumberOfElements()
          Returns the number of elements currently on this Slice.
 int getSize()
          Returns the size of the Slice.
 Sort getSort()
          Returns the sorting parameters for the Slice.
 boolean hasContent()
          Returns whether the Slice has content at all.
 boolean hasNext()
          Returns if there is a next Slice.
 boolean hasPrevious()
          Returns if there is a previous Slice.
 boolean isFirst()
          Returns whether the current Slice is the first one.
 boolean isLast()
          Returns whether the current Slice is the last one.
 Pageable nextPageable()
          Returns the Pageable to request the next Slice.
 Pageable previousPageable()
          Returns the Pageable to request the previous Slice.
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

getNumber

int getNumber()
Returns the number of the current Slice. Is always non-negative.

Returns:
the number of the current Slice.

getSize

int getSize()
Returns the size of the Slice.

Returns:
the size of the Slice.

getNumberOfElements

int getNumberOfElements()
Returns the number of elements currently on this Slice.

Returns:
the number of elements currently on this Slice.

getContent

List<T> getContent()
Returns the page content as List.

Returns:

hasContent

boolean hasContent()
Returns whether the Slice has content at all.

Returns:

getSort

Sort getSort()
Returns the sorting parameters for the Slice.

Returns:

isFirst

boolean isFirst()
Returns whether the current Slice is the first one.

Returns:

isLast

boolean isLast()
Returns whether the current Slice is the last one.

Returns:

hasNext

boolean hasNext()
Returns if there is a next Slice.

Returns:
if there is a next Slice.

hasPrevious

boolean hasPrevious()
Returns if there is a previous Slice.

Returns:
if there is a previous Slice.

nextPageable

Pageable nextPageable()
Returns the Pageable to request the next Slice. Can be null in case the current Slice is already the last one. Clients should check hasNext() before calling this method to make sure they receive a non-null value.

Returns:

previousPageable

Pageable previousPageable()
Returns the Pageable to request the previous Slice. Can be null in case the current Slice is already the first one. Clients should check hasPrevious() before calling this method make sure receive a non-null value.

Returns:

Spring Data Core

Copyright © 2011-2014–2014 Pivotal Software, Inc.. All rights reserved.