Module org.jline.console
Package org.jline.console

Class ArgDesc

java.lang.Object
org.jline.console.ArgDesc
@Deprecated(since="4.0") public class ArgDesc extends Object
Deprecated.
Represents a command argument description used for generating command help and documentation. This class stores the name of an argument and its description as a list of attributed strings, which can include formatting and styling.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArgDesc(String name)
    Deprecated.
    Creates a new argument description with the specified name and an empty description.
    ArgDesc(String name, List<org.jline.utils.AttributedString> description)
    Deprecated.
    Creates a new argument description with the specified name and description.

  • Method Summary

    Modifier and Type
    Method
    Description
    static List<ArgDesc>
    doArgNames(List<String> names)
    Deprecated.
    Creates a list of argument descriptions from a list of argument names.
    List<org.jline.utils.AttributedString>
    getDescription()
    Deprecated.
    Returns the description of the argument as a list of attributed strings.
    String
    getName()
    Deprecated.
    Returns the name of the argument.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ArgDesc

      public ArgDesc(String name)
      Deprecated.
      Creates a new argument description with the specified name and an empty description.
      Parameters:
      name - the name of the argument
      Throws:
      IllegalArgumentException - if the name contains spaces or tabs

    • ArgDesc

      public ArgDesc(String name, List<org.jline.utils.AttributedString> description)
      Deprecated.
      Creates a new argument description with the specified name and description.
      Parameters:
      name - the name of the argument
      description - the description of the argument as a list of attributed strings
      Throws:
      IllegalArgumentException - if the name contains spaces or tabs

  • Method Details

    • getName

      public String getName()
      Deprecated.
      Returns the name of the argument.
      Returns:
      the argument name

    • getDescription

      public List<org.jline.utils.AttributedString> getDescription()
      Deprecated.
      Returns the description of the argument as a list of attributed strings.
      Returns:
      the argument description

    • doArgNames

      public static List<ArgDesc> doArgNames(List<String> names)
      Deprecated.
      Creates a list of argument descriptions from a list of argument names. Each argument description will have an empty description.
      Parameters:
      names - the list of argument names
      Returns:
      a list of argument descriptions