Package cloud.commandframework.annotations

Class SyntaxFragment

java.lang.Object

cloud.commandframework.annotations.SyntaxFragment

public final class SyntaxFragment
extends Object

Public since 1.7.0.

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentMode	getArgumentMode()	Returns the argument mode.
@NonNull String	getMajor()	Returns the major portion of the fragment.
@NonNull List<@NonNull String>	getMinor()	Returns the minor part of the fragment.

Methods inherited from class java.lang.Object

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

Method Details

getMajor

public @NonNull String getMajor()

Returns the major portion of the fragment.

This is likely the name of an argument, or a string literal.

Returns:

the major part of the fragment

getMinor

public @NonNull List<@NonNull String> getMinor()

Returns the minor part of the fragment.

This is likely a list of aliases.

Returns:

the minor part of the fragment.

getArgumentMode

public @NonNull ArgumentMode getArgumentMode()

Returns the argument mode.

Returns:

the argument mode