org.springframework.social.twitter.api
Class RateLimitStatus

java.lang.Object
  org.springframework.social.twitter.api.RateLimitStatus

public class RateLimitStatus
extends java.lang.Object

Carries data concerning the rate limit status.

Constructor Summary

RateLimitStatus(java.lang.String endpoint, int quarterOfHourLimit, int remainingHits, long resetTimeInSeconds)

Method Summary

java.lang.String	getEndpoint()
int	getQuarterOfHourLimit()
int	getRemainingHits()
java.util.Date	getResetTime()
long	getResetTimeInSeconds()
int	getSecondsUntilReset() The approximate number of seconds until the rate limits are reset.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitStatus

public RateLimitStatus(java.lang.String endpoint,
                       int quarterOfHourLimit,
                       int remainingHits,
                       long resetTimeInSeconds)

Method Detail

getEndpoint

public java.lang.String getEndpoint()

getQuarterOfHourLimit

public int getQuarterOfHourLimit()

getRemainingHits

public int getRemainingHits()

getResetTimeInSeconds

public long getResetTimeInSeconds()

getResetTime

public java.util.Date getResetTime()

getSecondsUntilReset

public int getSecondsUntilReset()

The approximate number of seconds until the rate limits are reset. Note that this method recalculates the seconds until reset on each call.