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

chore: migrate jetbrains annotations to jspecify #984

Open
wants to merge 1 commit into
base: main/4
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions api/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies {
api(libs.examination.api)
api(libs.examination.string)
compileOnlyApi(libs.jetbrainsAnnotations)
compileOnlyApi(libs.jspecify)
testImplementation(libs.guava)
annotationProcessor(projects.adventureAnnotationProcessors)
}
Expand Down
87 changes: 44 additions & 43 deletions api/src/main/java/net/kyori/adventure/audience/Audience.java

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions api/src/main/java/net/kyori/adventure/audience/Audiences.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,14 @@
import java.util.stream.Collector;
import java.util.stream.Collectors;
import net.kyori.adventure.text.ComponentLike;
import org.jetbrains.annotations.NotNull;
import org.jspecify.annotations.NullMarked;

/**
* {@link Audience}-related utilities.
*
* @since 4.13.0
*/
@NullMarked
public final class Audiences {
static final Collector<? super Audience, ?, ForwardingAudience> COLLECTOR = Collectors.collectingAndThen(
Collectors.toCollection(ArrayList::new),
Expand All @@ -52,7 +53,7 @@ private Audiences() {
* @return an action to send a message
* @since 4.13.0
*/
public static @NotNull Consumer<? super Audience> sendingMessage(final @NotNull ComponentLike message) {
public static Consumer<? super Audience> sendingMessage(final ComponentLike message) {
return audience -> audience.sendMessage(message);
}
}
40 changes: 20 additions & 20 deletions api/src/main/java/net/kyori/adventure/audience/EmptyAudience.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,86 +36,86 @@
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.ComponentLike;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.UnknownNullability;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

@NullMarked
final class EmptyAudience implements Audience {
static final EmptyAudience INSTANCE = new EmptyAudience();

@Override
public @NotNull <T> Optional<T> get(final @NotNull Pointer<T> pointer) {
public <T> Optional<T> get(final Pointer<T> pointer) {
return Optional.empty();
}

@Contract("_, null -> null; _, !null -> !null")
@Override
public <T> @Nullable T getOrDefault(final @NotNull Pointer<T> pointer, final @Nullable T defaultValue) {
public <T> @Nullable T getOrDefault(final Pointer<T> pointer, final @Nullable T defaultValue) {
return defaultValue;
}

@Override
public <T> @UnknownNullability T getOrDefaultFrom(final @NotNull Pointer<T> pointer, final @NotNull Supplier<? extends T> defaultValue) {
public <T> @Nullable T getOrDefaultFrom(final Pointer<T> pointer, final Supplier<? extends T> defaultValue) {
return defaultValue.get();
}

@Override
public @NotNull Audience filterAudience(final @NotNull Predicate<? super Audience> filter) {
public Audience filterAudience(final Predicate<? super Audience> filter) {
return this;
}

@Override
public void forEachAudience(final @NotNull Consumer<? super Audience> action) {
public void forEachAudience(final Consumer<? super Audience> action) {
}

@Override
public void sendMessage(final @NotNull ComponentLike message) {
public void sendMessage(final ComponentLike message) {
}

@Override
public void sendMessage(final @NotNull Component message) {
public void sendMessage(final Component message) {
}

@Override
@Deprecated
public void sendMessage(final @NotNull Identified source, final @NotNull Component message, final @NotNull MessageType type) {
public void sendMessage(final Identified source, final Component message, final MessageType type) {
}

@Override
@Deprecated
public void sendMessage(final @NotNull Identity source, final @NotNull Component message, final @NotNull MessageType type) {
public void sendMessage(final Identity source, final Component message, final MessageType type) {
}

@Override
public void sendMessage(final @NotNull Component message, final ChatType.@NotNull Bound boundChatType) {
public void sendMessage(final Component message, final ChatType.Bound boundChatType) {
}

@Override
public void sendMessage(final @NotNull SignedMessage signedMessage, final ChatType.@NotNull Bound boundChatType) {
public void sendMessage(final SignedMessage signedMessage, final ChatType.Bound boundChatType) {
}

@Override
public void deleteMessage(final SignedMessage.@NotNull Signature signature) {
public void deleteMessage(final SignedMessage.Signature signature) {
}

@Override
public void sendActionBar(final @NotNull ComponentLike message) {
public void sendActionBar(final ComponentLike message) {
}

@Override
public void sendPlayerListHeader(final @NotNull ComponentLike header) {
public void sendPlayerListHeader(final ComponentLike header) {
}

@Override
public void sendPlayerListFooter(final @NotNull ComponentLike footer) {
public void sendPlayerListFooter(final ComponentLike footer) {
}

@Override
public void sendPlayerListHeaderAndFooter(final @NotNull ComponentLike header, final @NotNull ComponentLike footer) {
public void sendPlayerListHeaderAndFooter(final ComponentLike header, final ComponentLike footer) {
}

@Override
public void openBook(final Book.@NotNull Builder book) {
public void openBook(final Book.Builder book) {
}

@Override
Expand Down
Loading