cloud.commandframework.bukkit.parsers.WorldArgument Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloud-bukkit Show documentation
Show all versions of cloud-bukkit Show documentation
Command framework and dispatcher for the JVM
//
// MIT License
//
// Copyright (c) 2022 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.bukkit.parsers;
import cloud.commandframework.ArgumentDescription;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.arguments.parser.ArgumentParseResult;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.bukkit.BukkitCaptionKeys;
import cloud.commandframework.captions.CaptionVariable;
import cloud.commandframework.context.CommandContext;
import cloud.commandframework.exceptions.parsing.NoInputProvidedException;
import cloud.commandframework.exceptions.parsing.ParserException;
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.bukkit.Bukkit;
import org.bukkit.World;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* cloud argument type that parses Bukkit {@link org.bukkit.World worlds}
*
* @param Command sender type
*/
public class WorldArgument extends CommandArgument {
protected WorldArgument(
final boolean required,
final @NonNull String name,
final @NonNull String defaultValue,
final @Nullable BiFunction, String, List> suggestionsProvider,
final @NonNull ArgumentDescription defaultDescription
) {
super(required, name, new WorldParser<>(), defaultValue, World.class, suggestionsProvider, defaultDescription);
}
/**
* Create a new {@link Builder}.
*
* @param name argument name
* @param sender type
* @return new {@link Builder}
* @since 1.8.0
*/
@API(status = API.Status.STABLE, since = "1.8.0")
public static @NonNull Builder builder(final @NonNull String name) {
return new Builder<>(name);
}
/**
* Create a new builder
*
* @param name Name of the argument
* @param Command sender type
* @return Created builder
* @deprecated prefer {@link #builder(String)}
*/
@API(status = API.Status.DEPRECATED, since = "1.8.0")
@Deprecated
public static @NonNull Builder newBuilder(final @NonNull String name) {
return builder(name);
}
/**
* Create a new required argument
*
* @param name Argument name
* @param Command sender type
* @return Created argument
*/
public static @NonNull CommandArgument of(final @NonNull String name) {
return WorldArgument.builder(name).asRequired().build();
}
/**
* Create a new optional argument
*
* @param name Argument name
* @param Command sender type
* @return Created argument
*/
public static @NonNull CommandArgument optional(final @NonNull String name) {
return WorldArgument.builder(name).asOptional().build();
}
/**
* Create a new optional argument with a default value
*
* @param name Argument name
* @param defaultValue Default value
* @param Command sender type
* @return Created argument
*/
public static @NonNull CommandArgument optional(
final @NonNull String name,
final @NonNull String defaultValue
) {
return WorldArgument.builder(name).asOptionalWithDefault(defaultValue).build();
}
public static final class Builder extends CommandArgument.Builder {
private Builder(final @NonNull String name) {
super(World.class, name);
}
@Override
public @NonNull CommandArgument build() {
return new WorldArgument<>(
this.isRequired(),
this.getName(),
this.getDefaultValue(),
this.getSuggestionsProvider(),
this.getDefaultDescription()
);
}
}
public static final class WorldParser implements ArgumentParser {
@Override
public @NonNull ArgumentParseResult parse(
final @NonNull CommandContext commandContext,
final @NonNull Queue inputQueue
) {
final String input = inputQueue.peek();
if (input == null) {
return ArgumentParseResult.failure(new NoInputProvidedException(
WorldParser.class,
commandContext
));
}
final World world = Bukkit.getWorld(input);
if (world == null) {
return ArgumentParseResult.failure(new WorldParseException(input, commandContext));
}
inputQueue.remove();
return ArgumentParseResult.success(world);
}
@Override
public @NonNull List suggestions(final @NonNull CommandContext commandContext, final @NonNull String input) {
return Bukkit.getWorlds().stream().map(World::getName).collect(Collectors.toList());
}
}
public static final class WorldParseException extends ParserException {
private static final long serialVersionUID = 561648144491587450L;
private final String input;
/**
* Construct a new WorldParseException
*
* @param input Input
* @param context Command context
*/
public WorldParseException(
final @NonNull String input,
final @NonNull CommandContext context
) {
super(
WorldParser.class,
context,
BukkitCaptionKeys.ARGUMENT_PARSE_FAILURE_WORLD,
CaptionVariable.of("input", input)
);
this.input = input;
}
/**
* Get the input provided by the sender
*
* @return Input
*/
public @NonNull String getInput() {
return this.input;
}
}
}