Expose noop implementations. (#129)

This commit is contained in:
Yang Song 2019-04-17 09:49:38 -07:00 committed by GitHub
parent 067d03a563
commit 0ff8127452
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 14 deletions

View File

@ -26,16 +26,21 @@ import openconsensus.metrics.data.LabelKey;
import openconsensus.metrics.data.LabelValue;
import openconsensus.metrics.data.Metric;
/** No-op implementations of metrics classes. */
final class NoopMetrics {
/**
* No-op implementations of metrics classes.
*
* @since 0.1.0
*/
public final class NoopMetrics {
private NoopMetrics() {}
/**
* Returns an instance that contains no-op implementations for all the instances.
*
* @return an instance that contains no-op implementations for all the instances.
* @since 0.1.0
*/
static MetricsComponent newNoopMetricsComponent() {
public static MetricsComponent newNoopMetricsComponent() {
return new NoopMetricsComponent();
}

View File

@ -27,8 +27,12 @@ import openconsensus.stats.view.ViewManager;
import openconsensus.stats.view.data.View;
import openconsensus.tags.TagMap;
/** No-op implementations of stats classes. */
final class NoopStats {
/**
* No-op implementations of stats classes.
*
* @since 0.1.0
*/
public final class NoopStats {
private NoopStats() {}
@ -36,8 +40,9 @@ final class NoopStats {
* Returns a {@code StatsRecorder} that is no-op implementation for {@link StatsRecorder}.
*
* @return a {@code StatsRecorder} that is no-op implementation for {@code StatsRecorder}.
* @since 0.1.0
*/
static StatsRecorder newNoopStatsRecorder() {
public static StatsRecorder newNoopStatsRecorder() {
return new NoopStatsRecorder();
}
@ -45,8 +50,9 @@ final class NoopStats {
* Returns a {@code ViewComponent} that has a no-op implementation for {@link ViewManager}.
*
* @return a {@code ViewComponent} that has a no-op implementation for {@code ViewManager}.
* @since 0.1.0
*/
static ViewComponent newNoopViewComponent() {
public static ViewComponent newNoopViewComponent() {
return new NoopViewComponent();
}

View File

@ -28,8 +28,12 @@ import openconsensus.tags.data.TagValue;
import openconsensus.tags.propagation.BinaryFormat;
import openconsensus.tags.propagation.TextFormat;
/** No-op implementations of tagging classes. */
final class NoopTags {
/**
* No-op implementations of tagging classes.
*
* @since 0.1.0
*/
public final class NoopTags {
private NoopTags() {}
@ -37,8 +41,9 @@ final class NoopTags {
* Returns a {@code Tagger} that is a no-op implementation for {@link Tagger}.
*
* @return a {@code Tagger} that is a no-op implementation for {@link Tagger}.
* @since 0.1.0
*/
static Tagger newNoopTagger() {
public static Tagger newNoopTagger() {
return new NoopTagger();
}

View File

@ -27,9 +27,12 @@ import openconsensus.trace.data.SpanData;
import openconsensus.trace.propagation.BinaryFormat;
import openconsensus.trace.propagation.TextFormat;
/** No-op implementations of trace classes. */
// TODO(Issue #65): decide whether this class should be public or not.
final class NoopTrace {
/**
* No-op implementations of trace classes.
*
* @since 0.1.0
*/
public final class NoopTrace {
private NoopTrace() {}
@ -37,8 +40,9 @@ final class NoopTrace {
* Returns a {@code Tracer} instance that is no-op implementations.
*
* @return a {@code Tracer} instance that is no-op implementations.
* @since 0.1.0
*/
static Tracer newNoopTracer() {
public static Tracer newNoopTracer() {
return new NoopTracer();
}