Module io.github.mmm.cli
Package io.github.mmm.cli.command

Interface CliCommandHelp

All Superinterfaces:
io.github.mmm.property.AttributeReadOnly, CliCommand, io.github.mmm.marshall.MarshallableObject, io.github.mmm.marshall.Marshaller<Object>, io.github.mmm.marshall.Marshalling<Object>, io.github.mmm.marshall.MarshallingObject, io.github.mmm.bean.ReadableBean, io.github.mmm.value.ReadablePath, io.github.mmm.marshall.id.StructuredIdMappingObject, io.github.mmm.marshall.UnmarshallableObject, io.github.mmm.marshall.Unmarshaller<Object>, io.github.mmm.validation.Validatable, io.github.mmm.bean.WritableBean, io.github.mmm.value.WritablePath
public interface CliCommandHelp extends CliCommand
CliCommand to print the help of the program.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.github.mmm.value.ReadablePath

    io.github.mmm.value.ReadablePath.PathBuilder

  • Field Summary

    Fields inherited from interface io.github.mmm.cli.command.CliCommand

    ALIAS_WILDCARD

    Fields inherited from interface io.github.mmm.bean.ReadableBean

    SUFFIX_PROPERTY

  • Method Summary

    Modifier and Type
    Method
    Description
    io.github.mmm.property.booleans.BooleanProperty
    Help()
     
    default void
    printJvmOptions(CliOut out, CliBundle helpBundle, CliConsole console)
     
    default int
    run(CliMain main)
    Executes this CliCommand.

    Methods inherited from interface io.github.mmm.property.AttributeReadOnly

    isReadOnly

    Methods inherited from interface io.github.mmm.cli.command.CliCommand

    hideFromHelp

    Methods inherited from interface io.github.mmm.marshall.MarshallableObject

    writeObject

    Methods inherited from interface io.github.mmm.bean.ReadableBean

    copy, doEquals, doToString, get, getAliases, getPropertyCount, isDynamic, isEqualTo, isPolymorphic, isPrototype, mapPropertyIds, newInstance, toString, validate

    Methods inherited from interface io.github.mmm.value.ReadablePath

    parentPath, path, path, path

    Methods inherited from interface io.github.mmm.marshall.UnmarshallableObject

    readObject

    Methods inherited from interface io.github.mmm.validation.Validatable

    validateOrThrow

    Methods inherited from interface io.github.mmm.bean.WritableBean

    addProperty, asTypeKey, createProperty, createProperty, defineIdMapping, getOrCreateProperty, getOrCreateProperty, getProperties, getProperty, getRequiredProperty, getType, pathSegment, pathSegment, read, set, set, set, setDynamic, write

    Methods inherited from interface io.github.mmm.value.WritablePath

    parentPath

  • Method Details

    • Help

      @PropertyAlias({"--help","-h"}) @Mandatory io.github.mmm.property.booleans.BooleanProperty Help()
      Returns:
      flag to activate this command.

    • run

      default int run(CliMain main)
      Description copied from interface: CliCommand
      Executes this CliCommand. Has to be implemented as default method.
      Specified by:
      run in interface CliCommand
      Parameters:
      main - the CliMain program.
      Returns:
      the exit code.

    • printJvmOptions

      default void printJvmOptions(CliOut out, CliBundle helpBundle, CliConsole console)
      Parameters:
      out - the CliOut for writing help output.
      helpBundle - the CliBundle for the help.
      console - the CliConsole if needed for output.