Package studio.mevera.imperat.command

Interface DescriptionHolder

All Known Subinterfaces:

AnnotatedArgument<S>, Argument<S>, Command<S>, CommandPathway<S>, FlagArgument<S>, NumericArgument<S>

All Known Implementing Classes:

AnnotationArgumentDecorator, FlagArgumentImpl, InputArgument, NumericArgumentDecorator

public interface DescriptionHolder

Represents an entity that can have a description. This interface provides methods to get and set a description.

Method Summary

Modifier and Type	Method	Description
default void	describe(String description)	Sets the description for this entity using a string.
void	describe(Description description)	Sets the description for this entity.
Description	getDescription()	Retrieves the current description associated with this entity.

Method Details

getDescription

Description getDescription()

Retrieves the current description associated with this entity.

Returns:

the current Description.

describe

void describe(Description description)

Sets the description for this entity.

Parameters:

description - the Description to set.

describe

default void describe(String description)

Sets the description for this entity using a string.

Parameters:

description - the string to create a Description from and set.