Package com.arpnetworking.tsdcore.sinks

Class UnitMappingSink

java.lang.Object

com.arpnetworking.tsdcore.sinks.BaseSink

com.arpnetworking.tsdcore.sinks.UnitMappingSink

All Implemented Interfaces:

Sink

public final class UnitMappingSink
extends BaseSink

Implementation of Sink which maps values in one unit to another.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UnitMappingSink.Builder	Implementation of builder pattern for UnitMappingSink.

Method Summary

Modifier and Type	Method	Description
void	close()	Called to allow the publisher to clean-up.
void	recordAggregateData(PeriodicData periodicData)	Called when additional PeriodicData instances are available for publication.
CompletionStage<Void>	shutdownGracefully()	Called to allow the publisher to clean-up.
Object	toLogValue()	Generate a Steno log compatible representation.

Methods inherited from class com.arpnetworking.tsdcore.sinks.BaseSink

getMetricSafeName, getName, toString

Methods inherited from class java.lang.Object

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

Method Details

recordAggregateData

public void recordAggregateData(PeriodicData periodicData)

Description copied from interface: Sink

Called when additional PeriodicData instances are available for publication.

Parameters:

periodicData - The {PeriodicData to be published.

close

public void close()

Description copied from interface: Sink

Called to allow the publisher to clean-up. No further calls to recordAggregation will be made after a call to close.

shutdownGracefully

public CompletionStage<Void> shutdownGracefully()

Description copied from interface: Sink

Called to allow the publisher to clean-up. No further calls to recordAggregation will be made after a call to close.

Returns:

A CompletionStage that completes when the sink is closed.

toLogValue

public Object toLogValue()

Generate a Steno log compatible representation.

Overrides:

toLogValue in class BaseSink

Returns:

Steno log compatible representation.