org.shredzone.flattr4j.connector

Class RateLimit

java.lang.Object

org.shredzone.flattr4j.connector.RateLimit

All Implemented Interfaces:

Serializable

public class RateLimit
extends Object
implements Serializable

Keeps the maximum rate of allowed calls and the remaining number of calls.

Note: The call limitation is posed by the Flattr API. This is not a limitation of flattr4j.

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateLimit()
RateLimit(FlattrObject data)
RateLimit(RateLimit limit) Copy constructor, creates a new RateLimit and copies the values of the given RateLimit.

Method Summary

Modifier and Type	Method and Description
Long	getCurrent() The number of calls made in the current time span.
Long	getLimit() The maximum rate of allowed calls per time span.
Long	getRemaining() The remaining rate of allowed calls per time span.
Date	getReset() The moment of the beginning of a new time span.
void	setCurrent(Long current)
void	setLimit(Long limit)
void	setRemaining(Long remaining)
void	setReset(Date reset)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimit

public RateLimit()

RateLimit

public RateLimit(RateLimit limit)

Copy constructor, creates a new RateLimit and copies the values of the given RateLimit.

Parameters:

limit - RateLimit to be copied

Since:

2.9

RateLimit

public RateLimit(FlattrObject data)

Since:

2.5

Method Detail

getLimit

public Long getLimit()

The maximum rate of allowed calls per time span. null if there is no such information available.

setLimit

public void setLimit(Long limit)

getRemaining

public Long getRemaining()

The remaining rate of allowed calls per time span. null if there is no such information available.

setRemaining

public void setRemaining(Long remaining)

getCurrent

public Long getCurrent()

The number of calls made in the current time span. null if there is no such information available.

Since:

2.5

setCurrent

public void setCurrent(Long current)

getReset

public Date getReset()

The moment of the beginning of a new time span. null if there is no such information available.

Since:

2.5

setReset

public void setReset(Date reset)