Skip to content

Commit

Permalink
Fix Tracer.java indenting (opentracing#112)
Browse files Browse the repository at this point in the history
Parts of it were 2-space rather than 4-space.

This led to noisy diffs in
opentracing#111
  • Loading branch information
bhs authored Mar 19, 2017
1 parent 30f713e commit bc1983e
Showing 1 changed file with 109 additions and 109 deletions.
218 changes: 109 additions & 109 deletions opentracing-api/src/main/java/io/opentracing/Tracer.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,113 +20,113 @@
*/
public interface Tracer {

/**
* Return a new SpanBuilder for a Span with the given `operationName`.
*
* <p>You can override the operationName later via {@link Span#setOperationName(String)}.
*
* <p>A contrived example:
* <pre>{@code
Tracer tracer = ...
Span parentSpan = tracer.buildSpan("DoWork")
.start();
Span http = tracer.buildSpan("HandleHTTPRequest")
.asChildOf(parentSpan.context())
.withTag("user_agent", req.UserAgent)
.withTag("lucky_number", 42)
.start();
}</pre>
*/
SpanBuilder buildSpan(String operationName);

/**
* Inject a SpanContext into a `carrier` of a given type, presumably for propagation across process boundaries.
*
* <p>Example:
* <pre>{@code
* Tracer tracer = ...
* Span clientSpan = ...
* TextMap httpHeadersCarrier = new AnHttpHeaderCarrier(httpRequest);
* tracer.inject(span.context(), Format.Builtin.HTTP_HEADERS, httpHeadersCarrier);
* }</pre>
*
* @param <C> the carrier type, which also parametrizes the Format.
* @param spanContext the SpanContext instance to inject into the carrier
* @param format the Format of the carrier
* @param carrier the carrier for the SpanContext state. All Tracer.inject() implementations must support io.opentracing.propagation.TextMap and java.nio.ByteBuffer.
*
* @see io.opentracing.propagation.Format
* @see io.opentracing.propagation.Format.Builtin
*/
<C> void inject(SpanContext spanContext, Format<C> format, C carrier);

/**
* Extract a SpanContext from a `carrier` of a given type, presumably after propagation across a process boundary.
*
* <p>Example:
* <pre>{@code
* Tracer tracer = ...
* TextMap httpHeadersCarrier = new AnHttpHeaderCarrier(httpRequest);
* SpanContext spanCtx = tracer.extract(Format.Builtin.HTTP_HEADERS, httpHeadersCarrier);
* tracer.buildSpan('...').asChildOf(spanCtx).start();
* }</pre>
*
* If the span serialized state is invalid (corrupt, wrong version, etc) inside the carrier this will result in an
* IllegalArgumentException.
*
* @param <C> the carrier type, which also parametrizes the Format.
* @param format the Format of the carrier
* @param carrier the carrier for the SpanContext state. All Tracer.extract() implementations must support
* io.opentracing.propagation.TextMap and java.nio.ByteBuffer.
*
* @return the SpanContext instance holding context to create a Span.
*
* @see io.opentracing.propagation.Format
* @see io.opentracing.propagation.Format.Builtin
*/
<C> SpanContext extract(Format<C> format, C carrier);


interface SpanBuilder extends SpanContext {

/**
* A shorthand for addReference(References.CHILD_OF, parent).
*/
SpanBuilder asChildOf(SpanContext parent);

/**
* A shorthand for addReference(References.CHILD_OF, parent.context()).
*/
SpanBuilder asChildOf(Span parent);

/**
* Add a reference from the Span being built to a distinct (usually parent) Span. May be called multiple times to
* represent multiple such References.
*
* @param referenceType the reference type, typically one of the constants defined in References
* @param referencedContext the SpanContext being referenced; e.g., for a References.CHILD_OF referenceType, the
* referencedContext is the parent
*
* @see io.opentracing.References
*/
SpanBuilder addReference(String referenceType, SpanContext referencedContext);

/** Same as {@link Span#setTag(String, String)}, but for the span being built. */
SpanBuilder withTag(String key, String value);

/** Same as {@link Span#setTag(String, boolean)}, but for the span being built. */
SpanBuilder withTag(String key, boolean value);

/** Same as {@link Span#setTag(String, Number)}, but for the span being built. */
SpanBuilder withTag(String key, Number value);

/** Specify a timestamp of when the Span was started, represented in microseconds since epoch. */
SpanBuilder withStartTimestamp(long microseconds);

/** Returns the started Span. */
Span start();

}
/**
* Return a new SpanBuilder for a Span with the given `operationName`.
*
* <p>You can override the operationName later via {@link Span#setOperationName(String)}.
*
* <p>A contrived example:
* <pre>{@code
Tracer tracer = ...
Span parentSpan = tracer.buildSpan("DoWork")
.start();
Span http = tracer.buildSpan("HandleHTTPRequest")
.asChildOf(parentSpan.context())
.withTag("user_agent", req.UserAgent)
.withTag("lucky_number", 42)
.start();
}</pre>
*/
SpanBuilder buildSpan(String operationName);

/**
* Inject a SpanContext into a `carrier` of a given type, presumably for propagation across process boundaries.
*
* <p>Example:
* <pre>{@code
* Tracer tracer = ...
* Span clientSpan = ...
* TextMap httpHeadersCarrier = new AnHttpHeaderCarrier(httpRequest);
* tracer.inject(span.context(), Format.Builtin.HTTP_HEADERS, httpHeadersCarrier);
* }</pre>
*
* @param <C> the carrier type, which also parametrizes the Format.
* @param spanContext the SpanContext instance to inject into the carrier
* @param format the Format of the carrier
* @param carrier the carrier for the SpanContext state. All Tracer.inject() implementations must support io.opentracing.propagation.TextMap and java.nio.ByteBuffer.
*
* @see io.opentracing.propagation.Format
* @see io.opentracing.propagation.Format.Builtin
*/
<C> void inject(SpanContext spanContext, Format<C> format, C carrier);

/**
* Extract a SpanContext from a `carrier` of a given type, presumably after propagation across a process boundary.
*
* <p>Example:
* <pre>{@code
* Tracer tracer = ...
* TextMap httpHeadersCarrier = new AnHttpHeaderCarrier(httpRequest);
* SpanContext spanCtx = tracer.extract(Format.Builtin.HTTP_HEADERS, httpHeadersCarrier);
* tracer.buildSpan('...').asChildOf(spanCtx).start();
* }</pre>
*
* If the span serialized state is invalid (corrupt, wrong version, etc) inside the carrier this will result in an
* IllegalArgumentException.
*
* @param <C> the carrier type, which also parametrizes the Format.
* @param format the Format of the carrier
* @param carrier the carrier for the SpanContext state. All Tracer.extract() implementations must support
* io.opentracing.propagation.TextMap and java.nio.ByteBuffer.
*
* @return the SpanContext instance holding context to create a Span.
*
* @see io.opentracing.propagation.Format
* @see io.opentracing.propagation.Format.Builtin
*/
<C> SpanContext extract(Format<C> format, C carrier);


interface SpanBuilder extends SpanContext {

/**
* A shorthand for addReference(References.CHILD_OF, parent).
*/
SpanBuilder asChildOf(SpanContext parent);

/**
* A shorthand for addReference(References.CHILD_OF, parent.context()).
*/
SpanBuilder asChildOf(Span parent);

/**
* Add a reference from the Span being built to a distinct (usually parent) Span. May be called multiple times to
* represent multiple such References.
*
* @param referenceType the reference type, typically one of the constants defined in References
* @param referencedContext the SpanContext being referenced; e.g., for a References.CHILD_OF referenceType, the
* referencedContext is the parent
*
* @see io.opentracing.References
*/
SpanBuilder addReference(String referenceType, SpanContext referencedContext);

/** Same as {@link Span#setTag(String, String)}, but for the span being built. */
SpanBuilder withTag(String key, String value);

/** Same as {@link Span#setTag(String, boolean)}, but for the span being built. */
SpanBuilder withTag(String key, boolean value);

/** Same as {@link Span#setTag(String, Number)}, but for the span being built. */
SpanBuilder withTag(String key, Number value);

/** Specify a timestamp of when the Span was started, represented in microseconds since epoch. */
SpanBuilder withStartTimestamp(long microseconds);

/** Returns the started Span. */
Span start();

}
}

0 comments on commit bc1983e

Please sign in to comment.