com.jakewharton.pingdom.services
Class ContactService.ListBuilder

java.lang.Object
  com.jakewharton.apibuilder.ApiBuilder
      com.jakewharton.pingdom.PingdomApiBuilder<List<Contact>>
          com.jakewharton.pingdom.services.ContactService.ListBuilder

Enclosing class:

ContactService

public static final class ContactService.ListBuilder
extends PingdomApiBuilder<List<Contact>>

Request builder for ContactService.list().

Nested Class Summary

Nested classes/interfaces inherited from class com.jakewharton.pingdom.PingdomApiBuilder

PingdomApiBuilder.HttpMethod

Field Summary

Fields inherited from class com.jakewharton.apibuilder.ApiBuilder

API_URL_PLACEHOLDER_END, API_URL_PLACEHOLDER_START

Method Summary

protected com.google.gson.JsonElement	execute() Execute the remote API method and return the JSON object result.
ContactService.ListBuilder	limit(int limit) Limits the number of returned results to the specified quantity.
ContactService.ListBuilder	offset(int offset) Offset for listing.

Methods inherited from class com.jakewharton.pingdom.PingdomApiBuilder

field, fire, parameter, parameter, parameter, parameter, postParameter, postParameter, postParameter, postParameter, postParameter

Methods inherited from class com.jakewharton.apibuilder.ApiBuilder

buildUrl, buildUrl, encodeUrl, field, field, field, field, field, hasField, hasParameter, parameter, parameter, parameter, parameter

Methods inherited from class java.lang.Object

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

Method Detail

execute

protected com.google.gson.JsonElement execute()

Description copied from class: PingdomApiBuilder

Execute the remote API method and return the JSON object result.

This method can be overridden to select a specific subset of the JSON object. The overriding implementation should still call 'super.execute()' and then perform the filtering from there.

Overrides:

execute in class PingdomApiBuilder<List<Contact>>

Returns:

JSON object instance.

limit

public ContactService.ListBuilder limit(int limit)

Limits the number of returned results to the specified quantity. (Optional)

Parameters:

limit - Result limit.

Returns:

Builder instance.

offset

public ContactService.ListBuilder offset(int offset)

Offset for listing. (Optional)

Parameters:

offset - Offset amount.

Returns:

Builder instance.