FrequencyStat (Javadocs [I2P+ 2.13.0+]

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

```
public class FrequencyStat
extends Object
```
coordinate an event frequency over various periods

Constructor Summary
Constructors
Constructor and Description
FrequencyStat(String name, String description, String group, long[] periods)
Create a new frequency stat.

Constructors
Constructor and Description
`FrequencyStat(String name, String description, String group, long[] periods)` Create a new frequency stat.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`coalesceStats()` coalesce all the stats
`boolean`	`equals(Object obj)` Compares this frequency stat to another object for equality.
`void`	`eventOccurred()` update all of the frequencies for the various periods
`String`	`getDescription()` Description of what this statistic measures.
`long`	`getEventCount()` Gets the lifetime event count.
`long`	`getFrequency()` Gets the lifetime average frequency.
`Frequency`	`getFrequency(long period)` Get the frequency object for the specified period.
`String`	`getGroupName()` Grouping name for this statistic.
`String`	`getName()` Unique name for this statistic.
`long[]`	`getPeriods()` Tracked periods for this frequency stat.
`int`	`hashCode()`
`void`	`store(OutputStream out, String prefix)` Serializes this FrequencyStat to the provided OutputStream

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

- Constructor Detail
  - FrequencyStat
```
public FrequencyStat(String name,
                     String description,
                     String group,
                     long[] periods)
```
    Create a new frequency stat.
    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)
- Method Detail
  - coalesceStats
```
public void coalesceStats()
```
    coalesce all the stats
  - equals
```
public boolean equals(Object obj)
```
    Compares this frequency stat to another object for equality. @since 0.8.2
    Overrides:
    equals in class Object
  - eventOccurred
```
public void eventOccurred()
```
    update all of the frequencies for the various periods
  - getDescription
```
public String getDescription()
```
    Description of what this statistic measures.
    Returns:
    a simple description of this statistic
  - getEventCount
```
public long getEventCount()
```
    Gets the lifetime event count.
    Returns:
    lifetime event count
  - getFrequency
```
public long getFrequency()
```
    Gets the lifetime average frequency.
    Returns:
    lifetime average frequency in millisedonds, i.e. the average time between events, or Long.MAX_VALUE if no events ever
  - getFrequency
```
public Frequency getFrequency(long period)
```
    Get the frequency object for the specified period.
    Parameters:
    period - the period in milliseconds
    Returns:
    the Frequency for the given period, or null if not found
  - getGroupName
```
public String getGroupName()
```
    Grouping name for this statistic.
    Returns:
    the grouping name under which this statistic is kept
  - getName
```
public String getName()
```
    Unique name for this statistic.
    Returns:
    the unique name of this statistic
  - getPeriods
```
public long[] getPeriods()
```
    Tracked periods for this frequency stat.
    Returns:
    the periods this frequency is tracked over, in milliseconds
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
  - store
```
public void store(OutputStream out,
                  String prefix)
           throws IOException
```
    Serializes this FrequencyStat to the provided OutputStream
    Parameters:
    out - to write to
    prefix - to prepend to the stat
    Throws:
    IOException - if something goes wrong

Class FrequencyStat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrequencyStat

Method Detail

coalesceStats

equals

eventOccurred

getDescription

getEventCount

getFrequency

getFrequency

getGroupName

getName

getPeriods

hashCode

store