Skip to content

Fix SpanLimitsBuilder Javadoc to match non-negative argument check #8516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
thswlsqls wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −10
Draft

Fix SpanLimitsBuilder Javadoc to match non-negative argument check #8516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions sdk/trace/src/main/java/io/opentelemetry/sdk/trace/SpanLimitsBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@ public final class SpanLimitsBuilder {
/**
* Sets the max number of attributes per {@link Span}.
*
* @param maxNumberOfAttributes the max number of attributes per {@link Span}. Must be positive.
* @param maxNumberOfAttributes the max number of attributes per {@link Span}. Must not be
* negative.
* @return this.
* @throws IllegalArgumentException if {@code maxNumberOfAttributes} is not positive.
* @throws IllegalArgumentException if {@code maxNumberOfAttributes} is negative.
*/
public SpanLimitsBuilder setMaxNumberOfAttributes(int maxNumberOfAttributes) {
Utils.checkArgument(maxNumberOfAttributes >= 0, "maxNumberOfAttributes must be non-negative");
Expand All @@ -42,9 +43,9 @@ public SpanLimitsBuilder setMaxNumberOfAttributes(int maxNumberOfAttributes) {
/**
* Sets the max number of events per {@link Span}.
*
* @param maxNumberOfEvents the max number of events per {@link Span}. Must be positive.
* @param maxNumberOfEvents the max number of events per {@link Span}. Must not be negative.
* @return this.
* @throws IllegalArgumentException if {@code maxNumberOfEvents} is not positive.
* @throws IllegalArgumentException if {@code maxNumberOfEvents} is negative.
*/
public SpanLimitsBuilder setMaxNumberOfEvents(int maxNumberOfEvents) {
Utils.checkArgument(maxNumberOfEvents >= 0, "maxNumberOfEvents must be non-negative");
Expand All @@ -55,9 +56,9 @@ public SpanLimitsBuilder setMaxNumberOfEvents(int maxNumberOfEvents) {
/**
* Sets the max number of links per {@link Span}.
*
* @param maxNumberOfLinks the max number of links per {@link Span}. Must be positive.
* @param maxNumberOfLinks the max number of links per {@link Span}. Must not be negative.
* @return this.
* @throws IllegalArgumentException if {@code maxNumberOfLinks} is not positive.
* @throws IllegalArgumentException if {@code maxNumberOfLinks} is negative.
*/
public SpanLimitsBuilder setMaxNumberOfLinks(int maxNumberOfLinks) {
Utils.checkArgument(maxNumberOfLinks >= 0, "maxNumberOfLinks must be non-negative");
Expand All @@ -68,9 +69,10 @@ public SpanLimitsBuilder setMaxNumberOfLinks(int maxNumberOfLinks) {
/**
* Sets the max number of attributes per event.
*
* @param maxNumberOfAttributesPerEvent the max number of attributes per event. Must be positive.
* @param maxNumberOfAttributesPerEvent the max number of attributes per event. Must not be
* negative.
* @return this.
* @throws IllegalArgumentException if {@code maxNumberOfAttributesPerEvent} is not positive.
* @throws IllegalArgumentException if {@code maxNumberOfAttributesPerEvent} is negative.
*/
public SpanLimitsBuilder setMaxNumberOfAttributesPerEvent(int maxNumberOfAttributesPerEvent) {
Utils.checkArgument(
Expand All @@ -82,9 +84,10 @@ public SpanLimitsBuilder setMaxNumberOfAttributesPerEvent(int maxNumberOfAttribu
/**
* Sets the max number of attributes per link.
*
* @param maxNumberOfAttributesPerLink the max number of attributes per link. Must be positive.
* @param maxNumberOfAttributesPerLink the max number of attributes per link. Must not be
* negative.
* @return this.
* @throws IllegalArgumentException if {@code maxNumberOfAttributesPerLink} is not positive.
* @throws IllegalArgumentException if {@code maxNumberOfAttributesPerLink} is negative.
*/
public SpanLimitsBuilder setMaxNumberOfAttributesPerLink(int maxNumberOfAttributesPerLink) {
Utils.checkArgument(
Expand Down
Loading