6ab1c8a2e0
* ✨ Add a new caption system to allow for the configuration of… * ✨ Add caption support to all numerical types * Add more standard pasres to the registry * Add default messages for captions * ✨ Improve captions in core * Add captions for Bukkit * ✨ Add FactoryDelegatingCaptionRegistry.java
57 lines
2.2 KiB
Java
57 lines
2.2 KiB
Java
//
|
|
// 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;
|
|
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
|
|
import java.lang.annotation.ElementType;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.lang.annotation.Target;
|
|
import java.util.function.BiFunction;
|
|
|
|
/**
|
|
* Annotation version of adding {@link cloud.commandframework.arguments.preprocessor.RegexPreprocessor}
|
|
* as a preprocessor using {@link cloud.commandframework.arguments.CommandArgument#addPreprocessor(BiFunction)}
|
|
*/
|
|
@Target(ElementType.PARAMETER)
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
public @interface Regex {
|
|
|
|
/**
|
|
* Regular expression pattern
|
|
*
|
|
* @return Pattern
|
|
*/
|
|
@NonNull String value();
|
|
|
|
/**
|
|
* Key for the caption used to generate the failure exception.
|
|
* Defaults to {@link cloud.commandframework.captions.StandardCaptionKeys#ARGUMENT_PARSE_FAILURE_REGEX}
|
|
*
|
|
* @return Failure caption key
|
|
*/
|
|
@NonNull String failureCaption() default "argument.parse.failure.regex";
|
|
|
|
}
|