twitter4jads.internal.models4j

Class RateLimitStatusImpl

java.lang.Object

twitter4jads.internal.models4j.RateLimitStatusImpl

All Implemented Interfaces:

java.io.Serializable, RateLimitStatus

public class RateLimitStatusImpl
extends java.lang.Object
implements RateLimitStatus

User: abhay Date: 4/5/16 Time: 11:29 AM

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RateLimitStatusImpl(int remaining, int limit, int resetTimeInSeconds)
RateLimitStatusImpl(int remaining, int limit, int resetTimeInSeconds, int costValue)

Method Summary

Modifier and Type	Method and Description
int	getLimit() Returns the current limit in effect This value is identical to the "X-Rate-Limit-Limit" response header.
int	getRemaining() Returns the remaining number of API requests available. This value is identical to the "X-Rate-Limit-Remaining" response header.
int	getRemainingHits() Returns the remaining number of API requests available. This value is identical to the "X-Rate-Limit-Remaining" response header.
int	getResetTimeInSeconds() Returns the seconds the current rate limiting period ends. This should be a same as getResetTime().getTime()/1000.
int	getSecondsUntilReset() Returns the amount of seconds until the current rate limiting period ends. This is a value provided/calculated only by Twitter4J for handiness and not a part of the twitter API spec.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitStatusImpl

public RateLimitStatusImpl(int remaining,
                           int limit,
                           int resetTimeInSeconds)

RateLimitStatusImpl

public RateLimitStatusImpl(int remaining,
                           int limit,
                           int resetTimeInSeconds,
                           int costValue)

Method Detail

getRemaining

public int getRemaining()

Description copied from interface: RateLimitStatus

Returns the remaining number of API requests available.
This value is identical to the "X-Rate-Limit-Remaining" response header.

Specified by:

getRemaining in interface RateLimitStatus

Returns:

the remaining number of API requests available

getRemainingHits

public int getRemainingHits()

Description copied from interface: RateLimitStatus

Returns the remaining number of API requests available.
This value is identical to the "X-Rate-Limit-Remaining" response header.

Specified by:

getRemainingHits in interface RateLimitStatus

Returns:

the remaining number of API requests available

getLimit

public int getLimit()

Description copied from interface: RateLimitStatus

Returns the current limit in effect
This value is identical to the "X-Rate-Limit-Limit" response header.

Specified by:

getLimit in interface RateLimitStatus

Returns:

the current limit in effect

getResetTimeInSeconds

public int getResetTimeInSeconds()

Description copied from interface: RateLimitStatus

Returns the seconds the current rate limiting period ends.
This should be a same as getResetTime().getTime()/1000.

Specified by:

getResetTimeInSeconds in interface RateLimitStatus

Returns:

the seconds the current rate limiting period ends

getSecondsUntilReset

public int getSecondsUntilReset()

Description copied from interface: RateLimitStatus

Returns the amount of seconds until the current rate limiting period ends.
This is a value provided/calculated only by Twitter4J for handiness and not a part of the twitter API spec.

Specified by:

getSecondsUntilReset in interface RateLimitStatus

Returns:

the amount of seconds until next rate limiting period

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object