Skip to content

Add comments explaining suppressed warnings in api common #7951

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

Merged
jkwatson merged 2 commits into from
Jan 4, 2026
Merged

Add comments explaining suppressed warnings in api common #7951

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fed78c8
Add comments explaining suppressed warnings in api common
Gosling-dude Jan 4, 2026
3634e2d
Clarify suppressed warnings comment in api common
Gosling-dude Jan 4, 2026
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
2 changes: 1 addition & 1 deletion api/all/src/main/java/io/opentelemetry/api/common/ArrayBackedAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public AttributesBuilder toBuilder() {
return new ArrayBackedAttributesBuilder(new ArrayList<>(data()));
}

@SuppressWarnings("unchecked")
@SuppressWarnings("unchecked") // safe cast: values are stored internally keyed by AttributeKey<T>
@Override
@Nullable
public <T> T get(AttributeKey<T> key) {
Expand Down
4 changes: 2 additions & 2 deletions api/all/src/main/java/io/opentelemetry/api/common/ArrayBackedAttributesBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ public <T> AttributesBuilder put(AttributeKey<T> key, @Nullable T value) {

@Override
@SuppressWarnings({"unchecked", "rawtypes"})
// Safe: Attributes guarantees iteration over matching AttributeKey<T> / value pairs.
// Raw types are used here to avoid additional allocations while copying entries.
Copy link
Contributor

@jkwatson jkwatson Jan 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generic types don't survive into compiled code, so this has nothing to do with allocations that I know of.

Copy link
Contributor Author

@Gosling-dude Gosling-dude Jan 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generic types don't survive into compiled code, so this has nothing to do with allocations that I know of.

Good catch, thanks for pointing that out. You're right, the allocation comment isn't accurate here. I'll update the comment to focus only on the type-safety guarantee.

public AttributesBuilder putAll(Attributes attributes) {
if (attributes == null) {
return this;
}
// Attributes must iterate over their entries with matching types for key / value, so this
// downcast to the raw type is safe.
attributes.forEach((key, value) -> put((AttributeKey) key, value));
return this;
}
Expand Down
Loading