Package com.unboundid.scim2.client.requests

Class ListResponseBuilder<T>

java.lang.Object

com.unboundid.scim2.client.requests.ListResponseBuilder<T>

All Implemented Interfaces:

SearchResultHandler<T>

public class ListResponseBuilder<T>
extends Object
implements SearchResultHandler<T>

A builder for ListResponses that is also a SearchResultHandler implementation.

Constructor Summary

Constructors

Constructor	Description
ListResponseBuilder()

Method Summary

Modifier and Type	Method	Description
ListResponse<T>	build()	Builds a List Response.
void	extension(String urn, com.fasterxml.jackson.databind.node.ObjectNode extensionObjectNode)	Handle a schema extension in the search response.
void	itemsPerPage(int itemsPerPage)	Handle the itemsPerPage in the search response.
boolean	resource(T scimResource)	Handle a search result resource.
void	startIndex(int startIndex)	Handle the startIndex in the search response.
void	totalResults(int totalResults)	Handle the totalResults in the search response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListResponseBuilder

public ListResponseBuilder()

Method Detail

startIndex

public void startIndex(int startIndex)

Handle the startIndex in the search response.

Specified by:

startIndex in interface SearchResultHandler<T>

Parameters:

startIndex - The startIndex.

itemsPerPage

public void itemsPerPage(int itemsPerPage)

Handle the itemsPerPage in the search response.

Specified by:

itemsPerPage in interface SearchResultHandler<T>

Parameters:

itemsPerPage - The itemsPerPage.

totalResults

public void totalResults(int totalResults)

Handle the totalResults in the search response.

Specified by:

totalResults in interface SearchResultHandler<T>

Parameters:

totalResults - The totalResults.

resource

public boolean resource(@NotNull
                        T scimResource)

Handle a search result resource.

Specified by:

resource in interface SearchResultHandler<T>

Parameters:

scimResource - A search result resource.

Returns:

true to continue processing the search result response or false to immediate stop further processing of the response.

extension

public void extension(@NotNull
                      String urn,
                      @NotNull
                      com.fasterxml.jackson.databind.node.ObjectNode extensionObjectNode)

Handle a schema extension in the search response.

This method currently does not perform any action and should not be used.

Specified by:

extension in interface SearchResultHandler<T>

Parameters:

urn - The URN of the extension schema.

extensionObjectNode - The ObjectNode representing the extension schema.

build

@NotNull
public ListResponse<T> build()

Builds a List Response.

Returns:

generated ListResponse.