Skip to content
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.

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

Consolidates notes on "extra" data #1424

Merged
merged 1 commit into from
Mar 12, 2024
Merged

Conversation

codefromthecrypt
Copy link
Member

Before this change, notes about state, particularly the "one instance per plugin" rule were not consolidated on the method that can cause problems addExtra. This migrates notes together with additional warnings that when we talk about this being used for propagation plugins, we also mean not for ad-hoc usage, as that can lead to excessive overhead.

See #1421

Before this change, notes about state, particularly the "one instance
per plugin" rule were not consolidated on the method that can cause
problems `addExtra`. This migrates notes together with additional
warnings that when we talk about this being used for propagation
plugins, we also mean not for ad-hoc usage, as that can lead to
excessive overhead.

See #1421

Signed-off-by: Adrian Cole <adrian@tetrate.io>
* @since 4.9
*/
public final List<Object> extra() {
Copy link
Member Author

Choose a reason for hiding this comment

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

type is final, so this is redundant

@@ -372,6 +374,24 @@ public Builder clearExtra() {
}

/**
* This is an advanced function used for {@link Propagation} plugins, such as
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@codefromthecrypt codefromthecrypt merged commit b7ece7b into master Mar 12, 2024
3 checks passed
@codefromthecrypt codefromthecrypt deleted the consolidate-extra-notes branch March 12, 2024 00:54
@codefromthecrypt
Copy link
Member Author

thanks for the look @reta!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants