org.dc.riot.lol.rx.service

Class RateRule

java.lang.Object

org.dc.riot.lol.rx.service.RateRule

public class RateRule
extends java.lang.Object

Generic object containing request count per time frame.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
RateRule(int requests, int per, java.util.concurrent.TimeUnit timeUnit) Requests / unit-time (e.g.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static RateRule	from(java.lang.String string)
static RateRule[]	getDevelopmentRates()
long	getMilliseconds()
int	getPer()
static RateRule[]	getProductionRates()
int	getRequests()
java.util.concurrent.TimeUnit	getTimeUnit()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RateRule

public RateRule(int requests,
                int per,
                java.util.concurrent.TimeUnit timeUnit)

Requests / unit-time (e.g. 500 requests per 10 minutes)

Parameters:

requests - number of requests

per - count of time units

timeUnit - time unit

Method Detail

getRequests

public int getRequests()

Returns:

request count

getPer

public int getPer()

Returns:

number of time units`

getTimeUnit

public java.util.concurrent.TimeUnit getTimeUnit()

Returns:

time unit

getMilliseconds

public long getMilliseconds()

Returns:

convenience method to retrieve number of milliseconds this RateRule specifies

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

from

public static RateRule from(java.lang.String string)

Parameters:

string - REQUESTS PER TimeUnit (e.g. 500 10 MINUTES, read as 500 requests per 10 minutes)

Returns:

a RateRule with the specified rate

Throws:

java.lang.IllegalArgumentException - if the given String cannot be parsed or contains invalid values

java.lang.NumberFormatException - if the either the requests or per values are not valid integers

getDevelopmentRates

public static RateRule[] getDevelopmentRates()

Returns:

two RateRules 500 10 minutes and 10 10 seconds

See Also:

Your Dashboard

getProductionRates

public static RateRule[] getProductionRates()

Returns:

two RateRules 180,000 10 MINUTES and 300 10 seconds

See Also:

Your Dashboard