org.gatein.api.page

Class PageQuery.Builder

java.lang.Object

org.gatein.api.page.PageQuery.Builder

Enclosing class:

PageQuery

public static class PageQuery.Builder
extends Object

The builder responsible for creating PageQuery objects.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT
static Pagination	DEFAULT_PAGINATION The default pagination used for PageQuery's with a limit set to DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor and Description
PageQuery.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
PageQuery	build() Creates a new PageQuery object represented by the state of this builder
PageQuery.Builder	from(PageQuery query) Creates a new builder from an existing PageQuery.
PageQuery.Builder	withDisplayName(String displayName) Sets the display name for this builder to be used to query all sites that have the displayName.
PageQuery.Builder	withFilter(Filter<Page> filter) Sets the filter for this builder
PageQuery.Builder	withNextPage() Sets the pagination of this builder to pagination.getNext() if it's not null.
PageQuery.Builder	withPagination(int offset, int limit) Sets the pagination object of this builder to use the specified offset and limit.
PageQuery.Builder	withPagination(Pagination pagination) Sets the pagination object of this builder
PageQuery.Builder	withPreviousPage() Sets the pagination of this builder to pagination.getPrevious() if it's not null.
PageQuery.Builder	withSiteId(SiteId siteId) Convenience method for setting both the site type and site name.
PageQuery.Builder	withSiteName(String siteName) Sets the siteName for this builder to be used to query all sites that have the name.
PageQuery.Builder	withSiteType(SiteType siteType) Sets the siteType for this builder to be used to query all sites that have the SiteType.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

Constant Field Values

DEFAULT_PAGINATION

public static final Pagination DEFAULT_PAGINATION

The default pagination used for PageQuery's with a limit set to DEFAULT_LIMIT

Constructor Detail

PageQuery.Builder

public PageQuery.Builder()

Method Detail

withSiteId

public PageQuery.Builder withSiteId(SiteId siteId)

Convenience method for setting both the site type and site name.

Parameters:

siteId - the site id

Returns:

the builder

withSiteType

public PageQuery.Builder withSiteType(SiteType siteType)

Sets the siteType for this builder to be used to query all sites that have the SiteType.

Parameters:

siteType - the site type

Returns:

this builder

withSiteName

public PageQuery.Builder withSiteName(String siteName)

Sets the siteName for this builder to be used to query all sites that have the name.

Parameters:

siteName - the site name

Returns:

this builder

withDisplayName

public PageQuery.Builder withDisplayName(String displayName)

Sets the display name for this builder to be used to query all sites that have the displayName.

Parameters:

displayName - the display name

Returns:

this builder

withPagination

public PageQuery.Builder withPagination(int offset,
                               int limit)

Sets the pagination object of this builder to use the specified offset and limit.

Parameters:

offset - the offset of the pagination

limit - the limit of the pagination

Returns:

this builder

withPagination

public PageQuery.Builder withPagination(Pagination pagination)

Sets the pagination object of this builder

Parameters:

pagination - the pagination object

Returns:

this builder

withNextPage

public PageQuery.Builder withNextPage()

Sets the pagination of this builder to pagination.getNext() if it's not null.

Returns:

this builder

withPreviousPage

public PageQuery.Builder withPreviousPage()

Sets the pagination of this builder to pagination.getPrevious() if it's not null.

Returns:

this builder

withFilter

public PageQuery.Builder withFilter(Filter<Page> filter)

Sets the filter for this builder

Parameters:

filter - the filter

Returns:

this builder

build

public PageQuery build()

Creates a new PageQuery object represented by the state of this builder

Returns:

a new PageQuery object

from

public PageQuery.Builder from(PageQuery query)

Creates a new builder from an existing PageQuery.

Parameters:

query - the query used to build the initial state of the builder

Returns:

a new builder