Package com.github.siroshun09.mccommand.bukkit.parser

Class SoundParser

java.lang.Object

com.github.siroshun09.mccommand.bukkit.parser.SoundParser

All Implemented Interfaces:

ArgumentParser<Sound>

public class SoundParser
extends Object
implements ArgumentParser<Sound>

A class that parses an Argument to an Sound.

Constructor Summary

Constructors

Constructor	Description
SoundParser()

Method Summary

Modifier and Type	Method	Description
@Nullable Sound	parse(@NotNull Argument argument)	Parses an Argument to a specified type and returns it.
@NotNull Sound	parseOrThrow(@NotNull Argument argument)	Parses an Argument to a specified type and returns it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.siroshun09.mccommand.common.argument.parser.ArgumentParser

generateException, generateException, parseOptional, parseOrDefault

Constructor Detail

SoundParser

public SoundParser()

Method Detail

parse

@Nullable
public @Nullable Sound parse(@NotNull
                             @NotNull Argument argument)

Parses an Argument to a specified type and returns it.

Specified by:

parse in interface ArgumentParser<Sound>

Parameters:

argument - the argument to be parsed

Returns:

the value to be parsed, or null if the parsing fails

parseOrThrow

@NotNull
public @NotNull Sound parseOrThrow(@NotNull
                                   @NotNull Argument argument)
                            throws IllegalArgumentException

Parses an Argument to a specified type and returns it.

Depending on the implementation, it is possible to use Throwable.getCause() to get the exception that caused the conversion to fail.

Specified by:

parseOrThrow in interface ArgumentParser<Sound>

Parameters:

argument - the argument to be parsed

Returns:

the value to be parsed, or null if the parsing fails

Throws:

IllegalArgumentException - if the parsing fails