public interface Statistics
StatisticsType
.
To get an instance of this interface use an instance of
StatisticsFactory
.
For improved performance, each statistic may be referred to by
its descriptor
.
For optimal performance, each statistic may be referred to by
its id
in the statistics object. Note that
ids can not be mapped back to their name and methods that take ids
are unsafe. It is important to call the correct type of method
for the given id. For example if your stat is a long then incLong
must be called instead of incInt.
Note that as of the 5.1 release the incInt
,
incLong
, and incDouble
methods no longer
return the new value of the statistic. They now return void
.
This incompatible change was made
to allow for a more efficient concurrent increment implementation.
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes these statistics.
|
Number |
get(StatisticDescriptor descriptor)
Returns the value of the identified statistic.
|
Number |
get(String name)
Returns the value of the named statistic.
|
double |
getDouble(int id)
Returns the value of the identified statistic of type
double . |
double |
getDouble(StatisticDescriptor descriptor)
Returns the value of the described statistic of type
double . |
double |
getDouble(String name)
Returns the value of the statistic of type
double at
the given name. |
int |
getInt(int id)
Returns the value of the identified statistic of type
int . |
int |
getInt(StatisticDescriptor descriptor)
Returns the value of the described statistic of type
int . |
int |
getInt(String name)
Returns the value of the statistic of type
int at
the given name. |
long |
getLong(int id)
Returns the value of the identified statistic of type
long . |
long |
getLong(StatisticDescriptor descriptor)
Returns the value of the described statistic of type
long . |
long |
getLong(String name)
Returns the value of the statistic of type
long at
the given name. |
long |
getNumericId()
Gets the number associated with this instance that helps identify it.
|
long |
getRawBits(StatisticDescriptor descriptor)
Returns the bits that represent the raw value of the described statistic.
|
long |
getRawBits(String name)
Returns the bits that represent the raw value of the named statistic.
|
String |
getTextId()
Gets the text associated with this instance that helps identify it.
|
StatisticsType |
getType()
Gets the
StatisticsType of this instance. |
long |
getUniqueId()
Gets a value that uniquely identifies this statistics.
|
void |
incDouble(int id,
double delta)
Increments the value of the identified statistic of type
double
by the given amount. |
void |
incDouble(StatisticDescriptor descriptor,
double delta)
Increments the value of the described statistic of type
double
by the given amount. |
void |
incDouble(String name,
double delta)
Increments the value of the statistic of type
double with
the given name by a given amount. |
void |
incInt(int id,
int delta)
Increments the value of the identified statistic of type
int
by the given amount. |
void |
incInt(StatisticDescriptor descriptor,
int delta)
Increments the value of the described statistic of type
int
by the given amount. |
void |
incInt(String name,
int delta)
Increments the value of the statistic of type
int with
the given name by a given amount. |
void |
incLong(int id,
long delta)
Increments the value of the identified statistic of type
long
by the given amount. |
void |
incLong(StatisticDescriptor descriptor,
long delta)
Increments the value of the described statistic of type
long
by the given amount. |
void |
incLong(String name,
long delta)
Increments the value of the statistic of type
long with
the given name by a given amount. |
boolean |
isAtomic()
Returns true if modifications are atomic.
|
boolean |
isClosed()
Returns true if the instance has been
closed . |
StatisticDescriptor |
nameToDescriptor(String name)
Returns the descriptor of the statistic with the given name in this
statistics instance.
|
int |
nameToId(String name)
Returns the id of the statistic with the given name in this
statistics instance.
|
void |
setDouble(int id,
double value)
Sets the value of a statistic with the given
id
whose type is double . |
void |
setDouble(StatisticDescriptor descriptor,
double value)
Sets the value of a described statistic of type
double |
void |
setDouble(String name,
double value)
Sets the value of a named statistic of type
double . |
void |
setInt(int id,
int value)
Sets the value of a statistic with the given
id
whose type is int . |
void |
setInt(StatisticDescriptor descriptor,
int value)
Sets the value of a described statistic of type
int |
void |
setInt(String name,
int value)
Sets the value of a named statistic of type
int |
void |
setLong(int id,
long value)
Sets the value of a statistic with the given
id
whose type is long . |
void |
setLong(StatisticDescriptor descriptor,
long value)
Sets the value of a described statistic of type
long |
void |
setLong(String name,
long value)
Sets the value of a named statistic of type
long . |
void close()
int nameToId(String name)
IllegalArgumentException
- No statistic named name
exists in this
statistics instance.StatisticsType.nameToId(java.lang.String)
StatisticDescriptor nameToDescriptor(String name)
IllegalArgumentException
- No statistic named name
exists in this
statistics instance.StatisticsType.nameToDescriptor(java.lang.String)
long getUniqueId()
StatisticsType getType()
StatisticsType
of this instance.String getTextId()
long getNumericId()
boolean isAtomic()
Returns false if modifications are not atomic. This means that modifications to this instance are cheaper but not thread safe.
boolean isClosed()
closed
.void setInt(int id, int value)
id
whose type is int
.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.void setInt(String name, int value)
int
IllegalArgumentException
- If no statistic exists named name
or
if the statistic with name name
is not of
type int
.void setInt(StatisticDescriptor descriptor, int value)
int
IllegalArgumentException
- If no statistic exists for the given descriptor
or
if the described statistic is not of
type int
.void setLong(int id, long value)
id
whose type is long
.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.void setLong(StatisticDescriptor descriptor, long value)
long
IllegalArgumentException
- If no statistic exists for the given descriptor
or
if the described statistic is not of
type long
.void setLong(String name, long value)
long
.IllegalArgumentException
- If no statistic exists named name
or
if the statistic with name name
is not of
type long
.void setDouble(int id, double value)
id
whose type is double
.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.void setDouble(StatisticDescriptor descriptor, double value)
double
IllegalArgumentException
- If no statistic exists for the given descriptor
or
if the described statistic is not of
type double
.void setDouble(String name, double value)
double
.IllegalArgumentException
- If no statistic exists named name
or
if the statistic with name name
is not of
type double
.int getInt(int id)
int
.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.int getInt(StatisticDescriptor descriptor)
int
.IllegalArgumentException
- If no statistic exists with the specified descriptor
or
if the described statistic is not of
type int
.int getInt(String name)
int
at
the given name.IllegalArgumentException
- If no statistic exists with name name
or
if the statistic named name
is not of
type int
.long getLong(int id)
long
.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.long getLong(StatisticDescriptor descriptor)
long
.IllegalArgumentException
- If no statistic exists with the specified descriptor
or
if the described statistic is not of
type long
.long getLong(String name)
long
at
the given name.IllegalArgumentException
- If no statistic exists with name name
or
if the statistic named name
is not of
type long
.double getDouble(int id)
double
.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.double getDouble(StatisticDescriptor descriptor)
double
.IllegalArgumentException
- If no statistic exists with the specified descriptor
or
if the described statistic is not of
type double
.double getDouble(String name)
double
at
the given name.IllegalArgumentException
- If no statistic exists with name name
or
if the statistic named name
is not of
type double
.Number get(StatisticDescriptor descriptor)
descriptor
- a statistic descriptor obtained with nameToDescriptor(java.lang.String)
or StatisticsType.nameToDescriptor(java.lang.String)
.IllegalArgumentException
- If the described statistic does not existNumber get(String name)
IllegalArgumentException
- If the named statistic does not existlong getRawBits(StatisticDescriptor descriptor)
descriptor
- a statistic descriptor obtained with nameToDescriptor(java.lang.String)
or StatisticsType.nameToDescriptor(java.lang.String)
.IllegalArgumentException
- If the described statistic does not existlong getRawBits(String name)
IllegalArgumentException
- If the named statistic does not existvoid incInt(int id, int delta)
int
by the given amount.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.void incInt(StatisticDescriptor descriptor, int delta)
int
by the given amount.IllegalArgumentException
- If no statistic exists with the given descriptor
or
if the described statistic is not of
type int
.void incInt(String name, int delta)
int
with
the given name by a given amount.IllegalArgumentException
- If no statistic exists with name name
or
if the statistic named name
is not of
type int
.void incLong(int id, long delta)
long
by the given amount.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.void incLong(StatisticDescriptor descriptor, long delta)
long
by the given amount.IllegalArgumentException
- If no statistic exists with the given descriptor
or
if the described statistic is not of
type long
.void incLong(String name, long delta)
long
with
the given name by a given amount.IllegalArgumentException
- If no statistic exists with name name
or
if the statistic named name
is not of
type long
.void incDouble(int id, double delta)
double
by the given amount.id
- a statistic id obtained with nameToId(java.lang.String)
or StatisticsType.nameToId(java.lang.String)
.ArrayIndexOutOfBoundsException
- If the id is invalid.void incDouble(StatisticDescriptor descriptor, double delta)
double
by the given amount.IllegalArgumentException
- If no statistic exists with the given descriptor
or
if the described statistic is not of
type double
.void incDouble(String name, double delta)
double
with
the given name by a given amount.IllegalArgumentException
- If no statistic exists with name name
or
if the statistic named name
is not of
type double
.Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.