Package org.incendo.cloud.help.result

Interface HelpQueryResult<C>

Type Parameters:
C - command sender type
All Known Subinterfaces:
IndexCommandResult<C>, MultipleCommandResult<C>, VerboseCommandResult<C>
@API(status=STABLE) public interface HelpQueryResult<C>
The result of a help query.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull HelpQuery<C>
    query()
    Returns the query.
    default void
    render(@NonNull HelpRenderer<C> renderer)
    Renders the result using the given renderer.

  • Method Details

    • query

      @NonNull HelpQuery<C> query()
      Returns the query.
      Returns:
      the query

    • render

      default void render(@NonNull HelpRenderer<C> renderer)
      Renders the result using the given renderer.
      Parameters:
      renderer - the renderer