org.cloudfoundry.client.v3

Class Pagination.Builder

java.lang.Object

org.cloudfoundry.client.v3.Pagination.Builder

Enclosing class:

Pagination

public static final class Pagination.Builder
extends Object

Builds instances of type Pagination. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
Pagination	build() Builds a new Pagination.
Pagination.Builder	first(Link first) Initializes the value for the first attribute.
Pagination.Builder	from(Pagination instance) Fill a builder with attribute values from the provided Pagination instance.
Pagination.Builder	last(Link last) Initializes the value for the last attribute.
Pagination.Builder	next(Link next) Initializes the value for the next attribute.
Pagination.Builder	previous(Link previous) Initializes the value for the previous attribute.
Pagination.Builder	totalPages(Integer totalPages) Initializes the value for the totalPages attribute.
Pagination.Builder	totalResults(Integer totalResults) Initializes the value for the totalResults attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Pagination.Builder from(Pagination instance)

Fill a builder with attribute values from the provided Pagination instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

first

public final Pagination.Builder first(Link first)

Initializes the value for the first attribute.

Parameters:

first - The value for first (can be null)

Returns:

this builder for use in a chained invocation

last

public final Pagination.Builder last(Link last)

Initializes the value for the last attribute.

Parameters:

last - The value for last (can be null)

Returns:

this builder for use in a chained invocation

next

public final Pagination.Builder next(Link next)

Initializes the value for the next attribute.

Parameters:

next - The value for next (can be null)

Returns:

this builder for use in a chained invocation

previous

public final Pagination.Builder previous(Link previous)

Initializes the value for the previous attribute.

Parameters:

previous - The value for previous (can be null)

Returns:

this builder for use in a chained invocation

totalPages

public final Pagination.Builder totalPages(Integer totalPages)

Initializes the value for the totalPages attribute.

Parameters:

totalPages - The value for totalPages (can be null)

Returns:

this builder for use in a chained invocation

totalResults

public final Pagination.Builder totalResults(Integer totalResults)

Initializes the value for the totalResults attribute.

Parameters:

totalResults - The value for totalResults (can be null)

Returns:

this builder for use in a chained invocation

build

public Pagination build()

Builds a new Pagination.

Returns:

An immutable instance of Pagination

Throws:

IllegalStateException - if any required attributes are missing