com.google.instrumentation.stats

Class StatsContext

java.lang.Object

com.google.instrumentation.stats.StatsContext

@Immutable
public abstract class StatsContext
extends Object

An immutable context for stats operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatsContext.Builder Builder for StatsContext.

Constructor Summary

Constructors

Constructor and Description
StatsContext()

Method Summary

Modifier and Type	Method and Description
abstract StatsContext.Builder	builder() Returns a builder based on this StatsContext.
abstract StatsContext	record(MeasurementMap measurements) Records the given measurements against this StatsContext.
abstract void	serialize(OutputStream output) Serializes the StatsContext into the on-the-wire representation.
StatsContext	with(TagKey k1, TagValue v1) Shorthand for builder().set(k1, v1).build()
StatsContext	with(TagKey k1, TagValue v1, TagKey k2, TagValue v2) Shorthand for builder().set(k1, v1).set(k2, v2).build()
StatsContext	with(TagKey k1, TagValue v1, TagKey k2, TagValue v2, TagKey k3, TagValue v3) Shorthand for builder().set(k1, v1).set(k2, v2).set(k3, v3).build()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatsContext

public StatsContext()

Method Detail

builder

public abstract StatsContext.Builder builder()

Returns a builder based on this StatsContext.

with

public final StatsContext with(TagKey k1,
                               TagValue v1)

Shorthand for builder().set(k1, v1).build()

with

public final StatsContext with(TagKey k1,
                               TagValue v1,
                               TagKey k2,
                               TagValue v2)

Shorthand for builder().set(k1, v1).set(k2, v2).build()

with

public final StatsContext with(TagKey k1,
                               TagValue v1,
                               TagKey k2,
                               TagValue v2,
                               TagKey k3,
                               TagValue v3)

Shorthand for builder().set(k1, v1).set(k2, v2).set(k3, v3).build()

record

public abstract StatsContext record(MeasurementMap measurements)

Records the given measurements against this StatsContext.

Parameters:

measurements - the measurements to record against the saved StatsContext

Returns:

this

serialize

public abstract void serialize(OutputStream output)
                        throws IOException

Serializes the StatsContext into the on-the-wire representation.

The inverse of StatsContextFactory.deserialize(java.io.InputStream) and should be based on the StatsContext protobuf representation.

Parameters:

output - the OutputStream to add the serialized form of this StatsContext.

Throws:

IOException