Module gomint.api

Class CommandOutput


  • public class CommandOutput
    extends Object
    Version:
    1.0
    Author:
    geNAZt
    • Constructor Detail

      • CommandOutput

        public CommandOutput()
    • Method Detail

      • fail

        public CommandOutput fail​(String format,
                                  Object... params)
        When the execution of a command failed you can execute this and must provide a reason why it failed
        Parameters:
        format - of the fail reason
        params - which should be filled into the given reason
        Returns:
        this command output instance
      • success

        public CommandOutput success​(String format,
                                     Object... params)
        When the execution of the command resulted in a success operation you can append a message here. All output from a command should be collected in a CommandOutput instance so the client can process it in the proper manner. Sending chat messages for the command result is NOT recommended and should NEVER be done
        Parameters:
        format - of the success message
        params - to pass into the given format
        Returns:
        this command output instance