org.javaswift.joss.client.core

Class AbstractPaginationMap<Child extends ListSubject>

java.lang.Object

org.javaswift.joss.client.core.AbstractPaginationMap<Child>

All Implemented Interfaces:

PaginationMap

Direct Known Subclasses:

AbstractListHolderPaginationMap, ContainerDirectoryPaginationMap

public abstract class AbstractPaginationMap<Child extends ListSubject>
extends java.lang.Object
implements PaginationMap

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
AbstractPaginationMap(java.lang.String prefix, int pageSize, int maxPageSize)

Method Summary

Modifier and Type	Method and Description
AbstractPaginationMap	buildMap()
abstract int	getCount()
java.lang.String	getMarker(java.lang.Integer page) Gets the marker text (ie, the name of the last record of the previous page) for navigating to another page.
int	getNumberOfPages() Returns the number of pages
int	getNumberOfRecords() Returns the number of records
int	getPageSize() Returns the page size
java.lang.String	getPrefix() Returns the prefix which is used to search the records
abstract java.util.Collection<Child>	list(java.lang.String prefix, java.lang.String marker, int blockSize)
java.util.Collection<Child>	listAllItems()
AbstractPaginationMap	setBlockSize(int blockSize)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

AbstractPaginationMap

public AbstractPaginationMap(java.lang.String prefix,
                             int pageSize,
                             int maxPageSize)

Method Detail

buildMap

public AbstractPaginationMap buildMap()

list

public abstract java.util.Collection<Child> list(java.lang.String prefix,
                                                 java.lang.String marker,
                                                 int blockSize)

getCount

public abstract int getCount()

listAllItems

public java.util.Collection<Child> listAllItems()

getMarker

public java.lang.String getMarker(java.lang.Integer page)

Description copied from interface: PaginationMap

Gets the marker text (ie, the name of the last record of the previous page) for navigating to another page. The OpenStack API requires this information (why don't they use a regular offset?).

Specified by:

getMarker in interface PaginationMap

Parameters:

page - the page to get the appropriate marker for

Returns:

the marker for the required page

getNumberOfPages

public int getNumberOfPages()

Description copied from interface: PaginationMap

Returns the number of pages

Specified by:

getNumberOfPages in interface PaginationMap

Returns:

number of pages

getPageSize

public int getPageSize()

Description copied from interface: PaginationMap

Returns the page size

Specified by:

getPageSize in interface PaginationMap

Returns:

page size

getNumberOfRecords

public int getNumberOfRecords()

Description copied from interface: PaginationMap

Returns the number of records

Specified by:

getNumberOfRecords in interface PaginationMap

Returns:

the number of records

getPrefix

public java.lang.String getPrefix()

Description copied from interface: PaginationMap

Returns the prefix which is used to search the records

Specified by:

getPrefix in interface PaginationMap

Returns:

the prefix

setBlockSize

public AbstractPaginationMap setBlockSize(int blockSize)