Skip to content

Commit

Permalink
Rename DocumentedSpan to SpanDocumentation (#73)
Browse files Browse the repository at this point in the history
This aligns the naming with the recent change in the micrometer repository for ObservationDocumentation and MeterDocumentation.

See micrometer-metrics/micrometer#3430
  • Loading branch information
shakuzen authored Sep 27, 2022
1 parent aafe996 commit 2ae567b
Showing 1 changed file with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,23 @@
* met
*
* <ul>
* <li>Metrics are grouped within an enum - the enum implements the {@link DocumentedSpan}
* interface</li>
* <li>Metrics are grouped within an enum - the enum implements the
* {@link SpanDocumentation} interface</li>
* <li>If the span contains {@link KeyName} then those need to be declared as nested
* enums</li>
* <li>If the span contains {@link EventValue} then those need to be declared as nested
* enums</li>
* <li>The {@link DocumentedSpan#getKeyNames()} need to call the nested enum's
* <li>The {@link SpanDocumentation#getKeyNames()} need to call the nested enum's
* {@code values()} method to retrieve the array of allowed keys</li>
* <li>The {@link DocumentedSpan#getEvents()} need to call the nested enum's
* <li>The {@link SpanDocumentation#getEvents()} need to call the nested enum's
* {@code values()} method to retrieve the array of allowed events</li>
* <li>Javadocs around enums will be used as description</li>
* </ul>
*
* @author Marcin Grzejszczak
* @since 1.0.0
*/
public interface DocumentedSpan {
public interface SpanDocumentation {

/**
* Empty key names.
Expand Down Expand Up @@ -86,7 +86,7 @@ default EventValue[] getEvents() {
/**
* Allowed key names.
* @return allowed key names - if set will override any key names coming from
* {@link DocumentedSpan#overridesDefaultSpanFrom()}
* {@link SpanDocumentation#overridesDefaultSpanFrom()}
*/
default KeyName[] getKeyNames() {
return EMPTY_KEY_NAMES;
Expand All @@ -95,7 +95,7 @@ default KeyName[] getKeyNames() {
/**
* Additional key names.
* @return additional key names - if set will append any key names coming from
* {@link DocumentedSpan#overridesDefaultSpanFrom()}
* {@link SpanDocumentation#overridesDefaultSpanFrom()}
*/
default KeyName[] getAdditionalKeyNames() {
return EMPTY_KEY_NAMES;
Expand Down

0 comments on commit 2ae567b

Please sign in to comment.