RateStat (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.stat.RateStat

```
public class RateStat
extends Object
```
coordinate a moving rate over various periods

Field Summary
Fields
Modifier and Type Field and Description
protected Rate[] _rates
actual rate objects for this statistic

Fields
Modifier and Type	Field and Description
`protected Rate[]`	`_rates` actual rate objects for this statistic

Constructor Summary
Constructors
Constructor and Description
RateStat(String name, String description, String group, long[] periods)
Unique name of the statistic.

Constructors
Constructor and Description
`RateStat(String name, String description, String group, long[] periods)` Unique name of the statistic.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addData(long value)` Update all of the rates for the various periods with the given value.
`void`	`addData(long value, long eventDuration)` Update all of the rates for the various periods with the given value.
`void`	`coalesceStats()` coalesce all the stats
`boolean`	`containsRate(long period)` Tests if a rate with the provided period exists within this RateStat.
`boolean`	`equals(Object obj)` Object to compare.
`String`	`getDescription()` Description of what this rate stat measures.
`String`	`getGroupName()` Grouping name for this rate stat.
`double`	`getLifetimeAverageValue()` Lifetime average from the shortest period.
`long`	`getLifetimeEventCount()` Lifetime event count from the shortest period.
`String`	`getName()` Unique name for this rate stat.
`long[]`	`getPeriods()` Tracked periods for this rate.
`Rate`	`getRate(long period)` Returns rate with requested period if it exists, otherwise null
`int`	`hashCode()`
`void`	`load(Properties props, String prefix, boolean treatAsCurrent)` Load this rate stat from the properties, populating all of the rates contained underneath it.
`(package private) boolean`	`nameGroupDescEquals(RateStat rs)` Whether the other stat shares name, group, and description.
`void`	`store(OutputStream out, String prefix)` Includes comment lines
`void`	`store(OutputStream out, String prefix, boolean addComments)` Stores the rate statistics to an output stream.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - _rates
```
protected final Rate[] _rates
```
    actual rate objects for this statistic
- Constructor Detail
  - RateStat
```
public RateStat(String name,
                String description,
                String group,
                long[] periods)
```
    Unique name of the statistic.
    Parameters:
    name - unique name of the statistic
    description - simple description of the statistic
    group - used to group statistics together
    periods - array of period lengths (in milliseconds), must not be empty
    Throws:
    IllegalArgumentException - if periods is empty
- Method Detail
  - addData
```
public void addData(long value)
```
    Update all of the rates for the various periods with the given value. Zero duration.
    Parameters:
    value - the value
  - addData
```
public void addData(long value,
                    long eventDuration)
```
    Update all of the rates for the various periods with the given value.
    Parameters:
    value - the value
    eventDuration - the event duration
  - coalesceStats
```
public void coalesceStats()
```
    coalesce all the stats
  - containsRate
```
public boolean containsRate(long period)
```
    Tests if a rate with the provided period exists within this RateStat.
    Parameters:
    period - ms
    Returns:
    true if exists
  - equals
```
public boolean equals(Object obj)
```
    Object to compare.
    Overrides:
    equals in class Object
    Parameters:
    obj - the object to compare
    Returns:
    true if equal by name, group, description, and rates
  - getDescription
```
public String getDescription()
```
    Description of what this rate stat measures.
    Returns:
    a simple description of this statistic
  - getGroupName
```
public String getGroupName()
```
    Grouping name for this rate stat.
    Returns:
    the grouping name under which this statistic is kept
  - getLifetimeAverageValue
```
public double getLifetimeAverageValue()
```
    Lifetime average from the shortest period.
    Returns:
    the lifetime average value from the shortest period's rate
  - getLifetimeEventCount
```
public long getLifetimeEventCount()
```
    Lifetime event count from the shortest period.
    Returns:
    the lifetime event count from the shortest period's rate
  - getName
```
public String getName()
```
    Unique name for this rate stat.
    Returns:
    the unique name of this statistic
  - getPeriods
```
public long[] getPeriods()
```
    Tracked periods for this rate.
    Returns:
    the periods this rate is tracked over, in milliseconds
  - getRate
```
public Rate getRate(long period)
```
    Returns rate with requested period if it exists, otherwise null
    Parameters:
    period - ms
    Returns:
    the Rate
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
  - load
```
public void load(Properties props,
                 String prefix,
                 boolean treatAsCurrent)
          throws IllegalArgumentException
```
    Load this rate stat from the properties, populating all of the rates contained underneath it. The comes from the given prefix (e.g. if we are given the prefix "profile.dbIntroduction", a series of rates may be found underneath "profile.dbIntroduction.60s", "profile.dbIntroduction.60m", and "profile.dbIntroduction.24h"). This RateStat must already be created, with the specified rate entries constructued - this merely loads them with data.
    Parameters:
    props - the properties
    prefix - prefix to the property entries (should NOT end with a period)
    treatAsCurrent - if true, we'll treat the loaded data as if no time has elapsed since it was written out, but if it is false, we'll treat the data with as much freshness (or staleness) as appropriate.
    Throws:
    IllegalArgumentException - if the data was formatted incorrectly
  - nameGroupDescEquals
```
boolean nameGroupDescEquals(RateStat rs)
```
    Whether the other stat shares name, group, and description.
    Parameters:
    rs - the other RateStat
  - store
```
public void store(OutputStream out,
                  String prefix)
           throws IOException
```
    Includes comment lines
    Parameters:
    out - the output stream
    prefix - the property prefix
    Throws:
    IOException - if an I/O error occurs
  - store
```
public void store(OutputStream out,
                  String prefix,
                  boolean addComments)
           throws IOException
```
    Stores the rate statistics to an output stream.
    Parameters:
    out - the output stream
    prefix - the property prefix
    addComments - add comment lines to the output
    Throws:
    IOException - if an I/O error occurs
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object

Class RateStat

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_rates

Constructor Detail

RateStat

Method Detail

addData

addData

coalesceStats

containsRate

equals

getDescription

getGroupName

getLifetimeAverageValue

getLifetimeEventCount

getName

getPeriods

getRate

hashCode

load

nameGroupDescEquals

store

store

toString