com.jcabi.github

Class Bulk<T extends JsonReadable>

java.lang.Object

com.jcabi.github.Bulk<T>

Type Parameters:

T - Type of iterable objects

All Implemented Interfaces:

Iterable<T>

public final class Bulk<T extends JsonReadable>
extends Object
implements Iterable<T>

Bulk items, with pre-saved JSON.

This class should be used as a decorator for object obtained from Github, when you want to keep their JSON values in memory. For example:

 Iterable<Issue> issues = repo.issues().iterate(
   new HashMap<String, String>()
 );
 for (Issue issue : issues) {
   System.out.println(new Issue.Smart(issue).title());
 }

Let's say, there are 50 issues in Github's repo. This code will make 52 HTTP requests to Github. The first one will fetch the first 30 issues in JSON array. Then, for every one of them, in order to retrieve issue title a separate HTTP request will be made. Then, one more page will be fetched, with 20 issues. And again, 20 new HTTP requests to get their titles.

Class Bulk helps us to reduce the amount of this extra work:

 Iterable<Issue> issues = new Bulk<Issue>(
   repo.issues().iterate(
     new HashMap<String, String>()
   )
 );

Now, there will be just two HTTP requests.

Since:

0.4

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Pagination

Constructor Summary

Constructors

Constructor and Description
Bulk(Iterable<T> items) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<T>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Bulk

public Bulk(@NotNull(message="items can\'t be NULL")
    Iterable<T> items)

Public ctor.

Parameters:

items - Items original

Suppressed Checkstyle violations:

AnonInnerLength (50 lines)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

iterator

@NotNull(message="iterator is never NULL")
public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends JsonReadable>