com.jcabi.github

Class RtPagination<T>

java.lang.Object

com.jcabi.github.RtValuePagination<T,javax.json.JsonObject>

com.jcabi.github.RtPagination<T>

Type Parameters:

T - Type of iterable objects

All Implemented Interfaces:

Iterable<T>

@Immutable
public final class RtPagination<T>
extends RtValuePagination<T,javax.json.JsonObject>

Github pagination.

This class is a convenient iterator over multiple JSON objects returned by Github API. For example, to iterate through notifications (see Notifications API) you can use this code:

 Iterable<JsonObject> notifications = new RtPagination<>(
   new RtGithub(oauth).entry()
     .uri().path("/notifications").back(),
   RtPagination.COPYING
 );

Since:

0.4, 0.11

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Pagination

Nested Class Summary

Nested classes/interfaces inherited from class com.jcabi.github.RtValuePagination

RtValuePagination.Mapping<X,P extends javax.json.JsonValue>

Field Summary

Fields

Modifier and Type	Field and Description
static RtValuePagination.Mapping<javax.json.JsonObject,javax.json.JsonObject>	COPYING Mapping that just copies JsonObject.

Constructor Summary

Constructors

Constructor and Description
RtPagination(com.jcabi.http.Request req, RtValuePagination.Mapping<T,javax.json.JsonObject> mpp) Public ctor.

Method Summary

Methods inherited from class com.jcabi.github.RtValuePagination

iterator, mapping, request, toString

Methods inherited from class java.lang.Object

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

Field Detail

COPYING

public static final RtValuePagination.Mapping<javax.json.JsonObject,javax.json.JsonObject> COPYING

Mapping that just copies JsonObject.

Constructor Detail

RtPagination

public RtPagination(@NotNull(message="request can\'t be NULL")
            com.jcabi.http.Request req,
            @NotNull(message="mapping can\'t be NULL")
            RtValuePagination.Mapping<T,javax.json.JsonObject> mpp)

Public ctor.

Parameters:

req - Request

mpp - Mapping