zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

✨ Add @Parser annotated methods

Browse source 
Fixes #166. Also fixes #180.
This commit is contained in:
Alexander Söderberg 2020-12-18 12:39:30 +01:00 • committed by Alexander Söderberg
parent c86ccbe1af
commit e5a35afb8a
9 changed files with 266 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

76
cloud-annotations/src/main/java/cloud/commandframework/annotations/parsers/MethodArgumentParser.java Normal file
View file

@ -0,0 +1,76 @@
//
// MIT License
//
// Copyright (c) 2020 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.annotations.parsers;
import cloud.commandframework.arguments.parser.ArgumentParseResult;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.context.CommandContext;
import org.checkerframework.checker.nullness.qual.NonNull;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.reflect.Method;
import java.util.Queue;
/**
* Represents a method annotated with {@link Parser}
*
* @param <C> Command sender type
* @param <T> Argument type
* @since 1.3.0
*/
public class MethodArgumentParser<C, T> implements ArgumentParser<C, T> {
private final MethodHandle methodHandle;
/**
* Create a new parser
*
* @param instance Instance that owns the method
* @param method The annotated method
* @throws Exception If the method lookup fails
*/
public MethodArgumentParser(
final @NonNull Object instance,
final @NonNull Method method
) throws Exception {
this.methodHandle = MethodHandles.lookup().unreflect(method).bindTo(instance);
}
@Override
@SuppressWarnings("unchecked")
public @NonNull ArgumentParseResult<@NonNull T> parse(
final @NonNull CommandContext<@NonNull C> commandContext,
final @NonNull Queue<@NonNull String> inputQueue
) {
try {
return ArgumentParseResult.success(
(T) this.methodHandle.invokeWithArguments(commandContext, inputQueue)
);
} catch (final Throwable t) {
return ArgumentParseResult.failure(t);
}
}
}

55
cloud-annotations/src/main/java/cloud/commandframework/annotations/parsers/Parser.java Normal file
View file

@ -0,0 +1,55 @@
//
// MIT License
//
// Copyright (c) 2020 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.annotations.parsers;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* This annotation allows you to create annotated methods that behave like argument parsers.
* The method must have this exact signature: <pre>{@code
* ﹫Parser("name") // Name may be left out
* public ParsedType methodName(CommandContext<YourSender> sender, Queue<String> input) {
* }}</pre>
* <p>
* The method can throw exceptions, and the thrown exceptions will automatically be
* wrapped by a {@link cloud.commandframework.arguments.parser.ArgumentParseResult#failure(Throwable)}
*
* @since 1.3.0
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Parser {
/**
* The name of the parser. If this is left empty, the parser will
* be registered as a default parser for the return type of the method
*
* @return Parser name
*/
String name() default "";
}

28
cloud-annotations/src/main/java/cloud/commandframework/annotations/parsers/package-info.java Normal file
View file

@ -0,0 +1,28 @@
//
// MIT License
//
// Copyright (c) 2020 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.
//
/**
* Classes related to {@link cloud.commandframework.annotations.parsers.Parser} annotated methods
*/
package cloud.commandframework.annotations.parsers;