diff options
author | sebright <sebright@google.com> | 2018-08-16 15:04:02 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-08-16 15:04:02 -0700 |
commit | 0a2f5799a2809b84e4c0da4b2cb743b798ca0fc8 (patch) | |
tree | 490a1b621c14107d5883f1cb1e093c428ac8f129 /api | |
parent | 3fdd48923a9bb0cdc4a29e18680f25a04f9ac5dd (diff) | |
download | opencensus-java-0a2f5799a2809b84e4c0da4b2cb743b798ca0fc8.tar.gz |
checkstyle: 8.0 -> 8.12 (#1369)
This commit also merges new changes to checkstyle.xml and fixes new checkstyle
warnings related to Javadocs.
Diffstat (limited to 'api')
7 files changed, 29 insertions, 13 deletions
diff --git a/api/src/main/java/io/opencensus/common/ServerStatsFieldEnums.java b/api/src/main/java/io/opencensus/common/ServerStatsFieldEnums.java index 79cb196e..ff3cfda9 100644 --- a/api/src/main/java/io/opencensus/common/ServerStatsFieldEnums.java +++ b/api/src/main/java/io/opencensus/common/ServerStatsFieldEnums.java @@ -99,19 +99,19 @@ public final class ServerStatsFieldEnums { */ public enum Size { /** - * Number of bytes used to represent latency observed at Load Balancer + * Number of bytes used to represent latency observed at Load Balancer. * * @since 0.16 */ SERVER_STATS_LB_LATENCY_SIZE(8), /** - * Number of bytes used to represent latency observed at Server + * Number of bytes used to represent latency observed at Server. * * @since 0.16 */ SERVER_STATS_SERVICE_LATENCY_SIZE(8), /** - * Number of bytes used to represent Trace option + * Number of bytes used to represent Trace option. * * @since 0.16 */ @@ -148,7 +148,7 @@ public final class ServerStatsFieldEnums { } /** - * Returns the total size required to encode the {@code ServerStats} + * Returns the total size required to encode the {@code ServerStats}. * * @return the total size required to encode all fields in {@code ServerStats}. * @since 0.16 diff --git a/api/src/main/java/io/opencensus/stats/BucketBoundaries.java b/api/src/main/java/io/opencensus/stats/BucketBoundaries.java index 20588d59..573a9e10 100644 --- a/api/src/main/java/io/opencensus/stats/BucketBoundaries.java +++ b/api/src/main/java/io/opencensus/stats/BucketBoundaries.java @@ -33,6 +33,8 @@ import javax.annotation.concurrent.Immutable; public abstract class BucketBoundaries { /** + * Returns a {@code BucketBoundaries} with the given buckets. + * * @param bucketBoundaries the boundaries for the buckets in the underlying histogram. * @return a new {@code BucketBoundaries} with the specified boundaries. * @throws NullPointerException if {@code bucketBoundaries} is null. diff --git a/api/src/main/java/io/opencensus/trace/NetworkEvent.java b/api/src/main/java/io/opencensus/trace/NetworkEvent.java index fafedf8e..722029e5 100644 --- a/api/src/main/java/io/opencensus/trace/NetworkEvent.java +++ b/api/src/main/java/io/opencensus/trace/NetworkEvent.java @@ -118,6 +118,8 @@ public abstract class NetworkEvent extends io.opencensus.trace.BaseMessageEvent public abstract long getCompressedMessageSize(); /** + * Returns the uncompressed size in bytes of the {@code NetworkEvent}. + * * @deprecated Use {@link #getUncompressedMessageSize}. * @return the uncompressed size in bytes of the {@code NetworkEvent}. * @since 0.5 @@ -153,6 +155,8 @@ public abstract class NetworkEvent extends io.opencensus.trace.BaseMessageEvent public abstract Builder setKernelTimestamp(@Nullable Timestamp kernelTimestamp); /** + * Sets the uncompressed message size. + * * @deprecated Use {@link #setUncompressedMessageSize}. * @param messageSize represents the uncompressed size in bytes of this message. * @return this. diff --git a/api/src/main/java/io/opencensus/trace/Span.java b/api/src/main/java/io/opencensus/trace/Span.java index 0fc62daf..8f8253b4 100644 --- a/api/src/main/java/io/opencensus/trace/Span.java +++ b/api/src/main/java/io/opencensus/trace/Span.java @@ -117,6 +117,10 @@ public abstract class Span { } /** + * Sets a set of attributes to the {@code Span}. The effect of this call is equivalent to that of + * calling {@link #putAttribute(String, AttributeValue)} once for each element in the specified + * map. + * * @deprecated Use {@link #putAttributes(Map)} * @param attributes the attributes that will be added and associated with the {@code Span}. * @since 0.5 diff --git a/api/src/main/java/io/opencensus/trace/TraceOptions.java b/api/src/main/java/io/opencensus/trace/TraceOptions.java index cdae92b3..f34ba190 100644 --- a/api/src/main/java/io/opencensus/trace/TraceOptions.java +++ b/api/src/main/java/io/opencensus/trace/TraceOptions.java @@ -202,6 +202,8 @@ public final class TraceOptions { } /** + * Sets the sampling bit in the options to true. + * * @deprecated Use {@code Builder.setIsSampled(true)}. * @return this. * @since 0.5 diff --git a/api/src/main/java/io/opencensus/trace/export/SampledSpanStore.java b/api/src/main/java/io/opencensus/trace/export/SampledSpanStore.java index 2347061b..5d00a45d 100644 --- a/api/src/main/java/io/opencensus/trace/export/SampledSpanStore.java +++ b/api/src/main/java/io/opencensus/trace/export/SampledSpanStore.java @@ -234,63 +234,63 @@ public abstract class SampledSpanStore { */ public enum LatencyBucketBoundaries { /** - * Stores finished successful requests of duration within the interval [0, 10us) + * Stores finished successful requests of duration within the interval [0, 10us). * * @since 0.5 */ ZERO_MICROSx10(0, TimeUnit.MICROSECONDS.toNanos(10)), /** - * Stores finished successful requests of duration within the interval [10us, 100us) + * Stores finished successful requests of duration within the interval [10us, 100us). * * @since 0.5 */ MICROSx10_MICROSx100(TimeUnit.MICROSECONDS.toNanos(10), TimeUnit.MICROSECONDS.toNanos(100)), /** - * Stores finished successful requests of duration within the interval [100us, 1ms) + * Stores finished successful requests of duration within the interval [100us, 1ms). * * @since 0.5 */ MICROSx100_MILLIx1(TimeUnit.MICROSECONDS.toNanos(100), TimeUnit.MILLISECONDS.toNanos(1)), /** - * Stores finished successful requests of duration within the interval [1ms, 10ms) + * Stores finished successful requests of duration within the interval [1ms, 10ms). * * @since 0.5 */ MILLIx1_MILLIx10(TimeUnit.MILLISECONDS.toNanos(1), TimeUnit.MILLISECONDS.toNanos(10)), /** - * Stores finished successful requests of duration within the interval [10ms, 100ms) + * Stores finished successful requests of duration within the interval [10ms, 100ms). * * @since 0.5 */ MILLIx10_MILLIx100(TimeUnit.MILLISECONDS.toNanos(10), TimeUnit.MILLISECONDS.toNanos(100)), /** - * Stores finished successful requests of duration within the interval [100ms, 1sec) + * Stores finished successful requests of duration within the interval [100ms, 1sec). * * @since 0.5 */ MILLIx100_SECONDx1(TimeUnit.MILLISECONDS.toNanos(100), TimeUnit.SECONDS.toNanos(1)), /** - * Stores finished successful requests of duration within the interval [1sec, 10sec) + * Stores finished successful requests of duration within the interval [1sec, 10sec). * * @since 0.5 */ SECONDx1_SECONDx10(TimeUnit.SECONDS.toNanos(1), TimeUnit.SECONDS.toNanos(10)), /** - * Stores finished successful requests of duration within the interval [10sec, 100sec) + * Stores finished successful requests of duration within the interval [10sec, 100sec). * * @since 0.5 */ SECONDx10_SECONDx100(TimeUnit.SECONDS.toNanos(10), TimeUnit.SECONDS.toNanos(100)), /** - * Stores finished successful requests of duration >= 100sec + * Stores finished successful requests of duration >= 100sec. * * @since 0.5 */ diff --git a/api/src/main/java/io/opencensus/trace/propagation/BinaryFormat.java b/api/src/main/java/io/opencensus/trace/propagation/BinaryFormat.java index 9b6c9632..7e875fd6 100644 --- a/api/src/main/java/io/opencensus/trace/propagation/BinaryFormat.java +++ b/api/src/main/java/io/opencensus/trace/propagation/BinaryFormat.java @@ -66,6 +66,8 @@ public abstract class BinaryFormat { static final NoopBinaryFormat NOOP_BINARY_FORMAT = new NoopBinaryFormat(); /** + * Serializes a {@link SpanContext} into a byte array using the binary format. + * * @deprecated use {@link #toByteArray(SpanContext)}. * @param spanContext the {@code SpanContext} to serialize. * @return the serialized binary value. @@ -91,6 +93,8 @@ public abstract class BinaryFormat { } /** + * Parses the {@link SpanContext} from a byte array using the binary format. + * * @deprecated use {@link #fromByteArray(byte[])}. * @param bytes a binary encoded buffer from which the {@code SpanContext} will be parsed. * @return the parsed {@code SpanContext}. |