Class StringTypeParser<S>

java.lang.Object

dev.ua.theroer.magicutils.commands.parsers.StringTypeParser<S>

Type Parameters:

S - sender type

All Implemented Interfaces:

TypeParser<S,String>

public class StringTypeParser<S>
extends Object
implements TypeParser<S,String>

Type parser for String arguments.

Constructor Summary

Constructors

Constructor	Description
StringTypeParser()	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canParse(@NotNull Class<?> type)	Checks if this parser can handle the given type.
int	getPriority()	Gets the priority of this parser.
@NotNull List<String>	getSuggestions(S sender)	Gets suggestions for this type.
@Nullable String	parse(@Nullable String value, @NotNull Class<String> targetType, S sender)	Parses the given value to the target type.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface TypeParser

canParseSuggestion, getSuggestions, getSuggestions, getSuggestionsFiltered, isEqual, isSender, parseDetailed, parseSuggestion

Constructor Details

StringTypeParser

public StringTypeParser()

Default constructor.

Method Details

canParse

public boolean canParse(@NotNull
 @NotNull Class<?> type)

Description copied from interface: TypeParser

Checks if this parser can handle the given type.

Specified by:

canParse in interface TypeParser<S,String>

Parameters:

type - the class type to check

Returns:

true if this parser can handle the type

parse

@Nullable
public @Nullable String parse(@Nullable
 @Nullable String value,
 @NotNull
 @NotNull Class<String> targetType,
 @NotNull
 S sender)

Description copied from interface: TypeParser

Parses the given value to the target type.

Specified by:

parse in interface TypeParser<S,String>

Parameters:

value - the string value to parse

targetType - the target class type

sender - the command sender (for context like @sender)

Returns:

the parsed object or null if parsing failed

getSuggestions

@NotNull
public @NotNull List<String> getSuggestions(@NotNull
 S sender)

Description copied from interface: TypeParser

Gets suggestions for this type.

Specified by:

getSuggestions in interface TypeParser<S,String>

Parameters:

sender - the command sender for context

Returns:

list of all possible suggestions

getPriority

public int getPriority()

Description copied from interface: TypeParser

Gets the priority of this parser. Higher priority parsers are checked first.

Specified by:

getPriority in interface TypeParser<S,String>

Returns:

the priority value