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

Remove checker qual and migrate to jetbrains annotations #390

Merged
merged 2 commits into from Jun 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion api/build.gradle.kts
Expand Up @@ -12,7 +12,6 @@ dependencies {
api(project(":adventure-key"))
api("net.kyori:examination-api:1.1.0")
api("net.kyori:examination-string:1.1.0")
compileOnlyApi("org.checkerframework:checker-qual:3.13.0")
compileOnlyApi("org.jetbrains:annotations:21.0.1")
testImplementation("com.google.guava:guava:23.0")
}
Expand Down
66 changes: 33 additions & 33 deletions api/src/main/java/net/kyori/adventure/audience/Audience.java
Expand Up @@ -35,7 +35,7 @@
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.ComponentLike;
import net.kyori.adventure.title.Title;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.jetbrains.annotations.NotNull;

/**
* A receiver of Minecraft media.
Expand Down Expand Up @@ -85,7 +85,7 @@ public interface Audience extends Pointered {
* @return a do-nothing audience
* @since 4.0.0
*/
static @NonNull Audience empty() {
static @NotNull Audience empty() {
return EmptyAudience.INSTANCE;
}

Expand All @@ -97,7 +97,7 @@ public interface Audience extends Pointered {
* @see ForwardingAudience
* @since 4.0.0
*/
static @NonNull Audience audience(final @NonNull Audience@NonNull... audiences) {
static @NotNull Audience audience(final @NotNull Audience@NotNull... audiences) {
final int length = audiences.length;
if (length == 0) {
return empty();
Expand All @@ -118,7 +118,7 @@ public interface Audience extends Pointered {
* @see ForwardingAudience
* @since 4.0.0
*/
static @NonNull ForwardingAudience audience(final @NonNull Iterable<? extends Audience> audiences) {
static @NotNull ForwardingAudience audience(final @NotNull Iterable<? extends Audience> audiences) {
return () -> audiences;
}

Expand All @@ -130,7 +130,7 @@ public interface Audience extends Pointered {
* @return a collector to create a forwarding audience
* @since 4.0.0
*/
static @NonNull Collector<? super Audience, ?, ForwardingAudience> toAudience() {
static @NotNull Collector<? super Audience, ?, ForwardingAudience> toAudience() {
return Audiences.COLLECTOR;
}

Expand All @@ -144,7 +144,7 @@ public interface Audience extends Pointered {
* @since 4.1.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull ComponentLike message) {
default void sendMessage(final @NotNull ComponentLike message) {
this.sendMessage(Identity.nil(), message);
}

Expand All @@ -157,7 +157,7 @@ default void sendMessage(final @NonNull ComponentLike message) {
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Identified source, final @NonNull ComponentLike message) {
default void sendMessage(final @NotNull Identified source, final @NotNull ComponentLike message) {
this.sendMessage(source, message.asComponent());
}

Expand All @@ -170,7 +170,7 @@ default void sendMessage(final @NonNull Identified source, final @NonNull Compon
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Identity source, final @NonNull ComponentLike message) {
default void sendMessage(final @NotNull Identity source, final @NotNull ComponentLike message) {
this.sendMessage(source, message.asComponent());
}

Expand All @@ -184,7 +184,7 @@ default void sendMessage(final @NonNull Identity source, final @NonNull Componen
* @since 4.1.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Component message) {
default void sendMessage(final @NotNull Component message) {
this.sendMessage(Identity.nil(), message);
}

Expand All @@ -197,7 +197,7 @@ default void sendMessage(final @NonNull Component message) {
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Identified source, final @NonNull Component message) {
default void sendMessage(final @NotNull Identified source, final @NotNull Component message) {
this.sendMessage(source, message, MessageType.SYSTEM);
}

Expand All @@ -210,7 +210,7 @@ default void sendMessage(final @NonNull Identified source, final @NonNull Compon
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Identity source, final @NonNull Component message) {
default void sendMessage(final @NotNull Identity source, final @NotNull Component message) {
this.sendMessage(source, message, MessageType.SYSTEM);
}

Expand All @@ -225,7 +225,7 @@ default void sendMessage(final @NonNull Identity source, final @NonNull Componen
* @since 4.1.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull ComponentLike message, final @NonNull MessageType type) {
default void sendMessage(final @NotNull ComponentLike message, final @NotNull MessageType type) {
this.sendMessage(Identity.nil(), message, type);
}

Expand All @@ -239,7 +239,7 @@ default void sendMessage(final @NonNull ComponentLike message, final @NonNull Me
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Identified source, final @NonNull ComponentLike message, final @NonNull MessageType type) {
default void sendMessage(final @NotNull Identified source, final @NotNull ComponentLike message, final @NotNull MessageType type) {
this.sendMessage(source, message.asComponent(), type);
}

Expand All @@ -253,7 +253,7 @@ default void sendMessage(final @NonNull Identified source, final @NonNull Compon
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Identity source, final @NonNull ComponentLike message, final @NonNull MessageType type) {
default void sendMessage(final @NotNull Identity source, final @NotNull ComponentLike message, final @NotNull MessageType type) {
this.sendMessage(source, message.asComponent(), type);
}

Expand All @@ -268,7 +268,7 @@ default void sendMessage(final @NonNull Identity source, final @NonNull Componen
* @since 4.1.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendMessage(final @NonNull Component message, final @NonNull MessageType type) {
default void sendMessage(final @NotNull Component message, final @NotNull MessageType type) {
this.sendMessage(Identity.nil(), message, type);
}

Expand All @@ -281,7 +281,7 @@ default void sendMessage(final @NonNull Component message, final @NonNull Messag
* @see Component
* @since 4.0.0
*/
default void sendMessage(final @NonNull Identified source, final @NonNull Component message, final @NonNull MessageType type) {
default void sendMessage(final @NotNull Identified source, final @NotNull Component message, final @NotNull MessageType type) {
this.sendMessage(source.identity(), message, type);
}

Expand All @@ -294,7 +294,7 @@ default void sendMessage(final @NonNull Identified source, final @NonNull Compon
* @see Component
* @since 4.0.0
*/
default void sendMessage(final @NonNull Identity source, final @NonNull Component message, final @NonNull MessageType type) {
default void sendMessage(final @NotNull Identity source, final @NotNull Component message, final @NotNull MessageType type) {
}

/**
Expand All @@ -305,7 +305,7 @@ default void sendMessage(final @NonNull Identity source, final @NonNull Componen
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendActionBar(final @NonNull ComponentLike message) {
default void sendActionBar(final @NotNull ComponentLike message) {
this.sendActionBar(message.asComponent());
}

Expand All @@ -316,7 +316,7 @@ default void sendActionBar(final @NonNull ComponentLike message) {
* @see Component
* @since 4.0.0
*/
default void sendActionBar(final @NonNull Component message) {
default void sendActionBar(final @NotNull Component message) {
}

/**
Expand All @@ -329,7 +329,7 @@ default void sendActionBar(final @NonNull Component message) {
* @since 4.3.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendPlayerListHeader(final @NonNull ComponentLike header) {
default void sendPlayerListHeader(final @NotNull ComponentLike header) {
this.sendPlayerListHeader(header.asComponent());
}

Expand All @@ -342,7 +342,7 @@ default void sendPlayerListHeader(final @NonNull ComponentLike header) {
* @param header the header
* @since 4.3.0
*/
default void sendPlayerListHeader(final @NonNull Component header) {
default void sendPlayerListHeader(final @NotNull Component header) {
this.sendPlayerListHeaderAndFooter(header, Component.empty());
}

Expand All @@ -356,7 +356,7 @@ default void sendPlayerListHeader(final @NonNull Component header) {
* @since 4.3.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendPlayerListFooter(final @NonNull ComponentLike footer) {
default void sendPlayerListFooter(final @NotNull ComponentLike footer) {
this.sendPlayerListFooter(footer.asComponent());
}

Expand All @@ -369,7 +369,7 @@ default void sendPlayerListFooter(final @NonNull ComponentLike footer) {
* @param footer the footer
* @since 4.3.0
*/
default void sendPlayerListFooter(final @NonNull Component footer) {
default void sendPlayerListFooter(final @NotNull Component footer) {
this.sendPlayerListHeaderAndFooter(Component.empty(), footer);
}

Expand All @@ -381,7 +381,7 @@ default void sendPlayerListFooter(final @NonNull Component footer) {
* @since 4.3.0
*/
@ForwardingAudienceOverrideNotRequired
default void sendPlayerListHeaderAndFooter(final @NonNull ComponentLike header, final @NonNull ComponentLike footer) {
default void sendPlayerListHeaderAndFooter(final @NotNull ComponentLike header, final @NotNull ComponentLike footer) {
this.sendPlayerListHeaderAndFooter(header.asComponent(), footer.asComponent());
}

Expand All @@ -392,7 +392,7 @@ default void sendPlayerListHeaderAndFooter(final @NonNull ComponentLike header,
* @param footer the footer
* @since 4.3.0
*/
default void sendPlayerListHeaderAndFooter(final @NonNull Component header, final @NonNull Component footer) {
default void sendPlayerListHeaderAndFooter(final @NotNull Component header, final @NotNull Component footer) {
}

/**
Expand All @@ -402,7 +402,7 @@ default void sendPlayerListHeaderAndFooter(final @NonNull Component header, fina
* @see Title
* @since 4.0.0
*/
default void showTitle(final @NonNull Title title) {
default void showTitle(final @NotNull Title title) {
}

/**
Expand Down Expand Up @@ -430,7 +430,7 @@ default void resetTitle() {
* @see BossBar
* @since 4.0.0
*/
default void showBossBar(final @NonNull BossBar bar) {
default void showBossBar(final @NotNull BossBar bar) {
}

/**
Expand All @@ -440,7 +440,7 @@ default void showBossBar(final @NonNull BossBar bar) {
* @see BossBar
* @since 4.0.0
*/
default void hideBossBar(final @NonNull BossBar bar) {
default void hideBossBar(final @NotNull BossBar bar) {
}

/**
Expand All @@ -450,7 +450,7 @@ default void hideBossBar(final @NonNull BossBar bar) {
* @see Sound
* @since 4.0.0
*/
default void playSound(final @NonNull Sound sound) {
default void playSound(final @NotNull Sound sound) {
}

/**
Expand All @@ -463,7 +463,7 @@ default void playSound(final @NonNull Sound sound) {
* @see Sound
* @since 4.0.0
*/
default void playSound(final @NonNull Sound sound, final double x, final double y, final double z) {
default void playSound(final @NotNull Sound sound, final double x, final double y, final double z) {
}

/**
Expand All @@ -473,7 +473,7 @@ default void playSound(final @NonNull Sound sound, final double x, final double
* @see SoundStop
* @since 4.0.0
*/
default void stopSound(final @NonNull SoundStop stop) {
default void stopSound(final @NotNull SoundStop stop) {
}

/**
Expand All @@ -486,7 +486,7 @@ default void stopSound(final @NonNull SoundStop stop) {
* @since 4.0.0
*/
@ForwardingAudienceOverrideNotRequired
default void openBook(final Book.@NonNull Builder book) {
default void openBook(final Book.@NotNull Builder book) {
this.openBook(book.build());
}

Expand All @@ -499,6 +499,6 @@ default void openBook(final Book.@NonNull Builder book) {
* @see Book
* @since 4.0.0
*/
default void openBook(final @NonNull Book book) {
default void openBook(final @NotNull Book book) {
}
}
35 changes: 19 additions & 16 deletions api/src/main/java/net/kyori/adventure/audience/EmptyAudience.java
Expand Up @@ -30,69 +30,72 @@
import net.kyori.adventure.inventory.Book;
import net.kyori.adventure.pointer.Pointer;
import net.kyori.adventure.text.ComponentLike;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.PolyNull;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.UnknownNullability;

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

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

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

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

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

@Override
public void sendMessage(final @NonNull Identified source, final @NonNull ComponentLike message) {
public void sendMessage(final @NotNull Identified source, final @NotNull ComponentLike message) {
}

@Override
public void sendMessage(final @NonNull Identity source, final @NonNull ComponentLike message) {
public void sendMessage(final @NotNull Identity source, final @NotNull ComponentLike message) {
}

@Override
public void sendMessage(final @NonNull ComponentLike message, final @NonNull MessageType type) {
public void sendMessage(final @NotNull ComponentLike message, final @NotNull MessageType type) {
}

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

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

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

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

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

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

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

@Override
Expand Down