Class MavenOption

java.lang.Object
org.apache.rat.ui.UIOption<MavenOption>
org.apache.rat.documentation.options.MavenOption
public final class MavenOption extends UIOption<MavenOption>
A representation of a Maven option based on a CLI option.

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getMethodName

      public String getMethodName()
      Gets the method name for this option.
      Returns:
      the method name for this option.

    • cleanupName

      protected String cleanupName(org.apache.commons.cli.Option option)
      Description copied from class: UIOption
      Provide means to wrap the given option depending on the UI-specific option implementation.
      Specified by:
      cleanupName in class UIOption<MavenOption>
      Parameters:
      option - The CLI option
      Returns:
      the cleaned up option name.

    • getText

      public String getText()
      Description copied from class: UIOption
      return a string showing long and short options if they are available. Will return a string.
      Specified by:
      getText in class UIOption<MavenOption>
      Returns:
      A string showing long and short options if they are available. Never null.

    • getExample

      public String getExample()
      Description copied from class: UIOption
      Gets an example of how to use this option in the native UI.
      Specified by:
      getExample in class UIOption<MavenOption>
      Returns:
      An example of how to use this option in the native UI.

    • getExample

      public String getExample(String... args)
      Create example text for the option.
      Parameters:
      args - the example arguments for the option.
      Returns:
      a formatted option.

    • getMethodSignature

      public String getMethodSignature(String indent, boolean multiple)

    • getPropertyAnnotation

      public String getPropertyAnnotation(String fname)