com.freya02.botcommands.api.parameters.QuotableRegexParameterResolver Maven / Gradle / Ivy

Go to download

package com.freya02.botcommands.api.parameters;

import org.jetbrains.annotations.NotNull;

import java.util.regex.Pattern;

/**
 * Interface which indicates this class can resolve parameters for regex commands.
 * 
Must be used with {@link RegexParameterResolver}.
 */
public interface QuotableRegexParameterResolver {
	/**
	 * Returns a quoted pattern of the parameter resolver
	 *
	 * @return A quoted pattern of the original {@link RegexParameterResolver regex parameter resolver}
	 *
	 * @see RegexParameterResolver#getPattern()
	 */
	@NotNull
	Pattern getQuotedPattern();
}