Deprecate argument newBuilder methods and add builder methods to align with newer arguments (#419)

This commit is contained in:
Jason 2022-12-13 08:54:54 -07:00
parent 306a1def9a
commit 99d388b708
39 changed files with 634 additions and 204 deletions

View file

@ -41,6 +41,7 @@ import java.util.List;
import java.util.Queue;
import java.util.function.BiFunction;
import java.util.stream.Collectors;
import org.apiguardian.api.API;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
@ -74,20 +75,30 @@ public final class PlayerArgument<C> extends CommandArgument<C, Player> {
}
/**
* Create a new argument builder
* Create a new {@link Builder}.
*
* @param name Argument name
* @param <C> Command sender type
* @return Constructed builder
* @param name argument name
* @param <C> sender type
* @return new {@link Builder}
* @since 1.8.0
*/
public static <C> CommandArgument.@NonNull Builder<C, Player> newBuilder(
final @NonNull String name
) {
return new Builder<C>(
name
).withParser(
new PlayerParser<>()
);
@API(status = API.Status.STABLE, since = "1.8.0")
public static <C> @NonNull Builder<C> builder(final @NonNull String name) {
return new Builder<>(name);
}
/**
* Create a new builder
*
* @param name Name of the argument
* @param <C> Command sender type
* @return Created builder
* @deprecated prefer {@link #builder(String)}
*/
@API(status = API.Status.DEPRECATED, since = "1.8.0")
@Deprecated
public static <C> @NonNull Builder<C> newBuilder(final @NonNull String name) {
return builder(name);
}
/**
@ -100,7 +111,7 @@ public final class PlayerArgument<C> extends CommandArgument<C, Player> {
public static <C> @NonNull CommandArgument<C, Player> of(
final @NonNull String name
) {
return PlayerArgument.<C>newBuilder(name).asRequired().build();
return PlayerArgument.<C>builder(name).asRequired().build();
}
/**
@ -113,7 +124,7 @@ public final class PlayerArgument<C> extends CommandArgument<C, Player> {
public static <C> @NonNull CommandArgument<C, Player> optional(
final @NonNull String name
) {
return PlayerArgument.<C>newBuilder(name).asOptional().build();
return PlayerArgument.<C>builder(name).asOptional().build();
}

View file

@ -41,6 +41,7 @@ import java.util.List;
import java.util.Queue;
import java.util.function.BiFunction;
import java.util.stream.Collectors;
import org.apiguardian.api.API;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
@ -74,20 +75,30 @@ public final class ServerArgument<C> extends CommandArgument<C, RegisteredServer
}
/**
* Create a new argument builder
* Create a new {@link Builder}.
*
* @param name Argument name
* @param <C> Command sender type
* @return Constructed builder
* @param name argument name
* @param <C> sender type
* @return new {@link Builder}
* @since 1.8.0
*/
public static <C> CommandArgument.@NonNull Builder<C, RegisteredServer> newBuilder(
final @NonNull String name
) {
return new Builder<C>(
name
).withParser(
new ServerParser<>()
);
@API(status = API.Status.STABLE, since = "1.8.0")
public static <C> @NonNull Builder<C> builder(final @NonNull String name) {
return new Builder<>(name);
}
/**
* Create a new builder
*
* @param name Name of the argument
* @param <C> Command sender type
* @return Created builder
* @deprecated prefer {@link #builder(String)}
*/
@API(status = API.Status.DEPRECATED, since = "1.8.0")
@Deprecated
public static <C> @NonNull Builder<C> newBuilder(final @NonNull String name) {
return builder(name);
}
/**
@ -100,7 +111,7 @@ public final class ServerArgument<C> extends CommandArgument<C, RegisteredServer
public static <C> @NonNull CommandArgument<C, RegisteredServer> of(
final @NonNull String name
) {
return ServerArgument.<C>newBuilder(name).asRequired().build();
return ServerArgument.<C>builder(name).asRequired().build();
}
/**
@ -111,7 +122,7 @@ public final class ServerArgument<C> extends CommandArgument<C, RegisteredServer
* @return Created argument
*/
public static <C> @NonNull CommandArgument<C, RegisteredServer> optional(final @NonNull String name) {
return ServerArgument.<C>newBuilder(name).asOptional().build();
return ServerArgument.<C>builder(name).asOptional().build();
}
public static final class Builder<C> extends CommandArgument.Builder<C, RegisteredServer> {