com.jcabi.github

Class Limit.Smart

java.lang.Object

com.jcabi.github.Limit.Smart

All Implemented Interfaces:

JsonReadable, Limit

Enclosing interface:

Limit

@Immutable
@Loggable(value=1)
public static final class Limit.Smart
extends Object
implements Limit

Smart limits with extra features.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.github.Limit

Limit.Smart, Limit.Throttled

Constructor Summary

Constructors

Constructor and Description
Limit.Smart(Limit limit) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Github	github() Github we're in.
javax.json.JsonObject	json() Describe it in a JSON object.
int	limit() Limit of number of requests.
int	remaining() Remaining number of requests.
Date	reset() When will the limit be reset.

Methods inherited from class java.lang.Object

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

Constructor Detail

Limit.Smart

public Limit.Smart(@NotNull(message="limit can\'t be NULL")
           Limit limit)

Public ctor.

Parameters:

limit - Limit

Method Detail

limit

public int limit()
          throws IOException

Limit of number of requests.

Returns:

Number of requests you can make in total

Throws:

IOException - If it fails

remaining

public int remaining()
              throws IOException

Remaining number of requests.

Returns:

Number of requests you can still make

Throws:

IOException - If it fails

reset

@NotNull(message="date is never NULL")
public Date reset()
           throws IOException

When will the limit be reset.

Returns:

Date when this will happen

Throws:

IOException - If it fails

json

@NotNull(message="JSON is never NULL")
public javax.json.JsonObject json()
                           throws IOException

Description copied from interface: JsonReadable

Describe it in a JSON object.

Specified by:

json in interface JsonReadable

Returns:

JSON object

Throws:

IOException - If there is any I/O problem

github

@NotNull(message="github is never NULL")
public Github github()

Description copied from interface: Limit

Github we're in.

Specified by:

github in interface Limit

Returns:

Github