Package org.jline.console
Class CmdLine
- java.lang.Object
-
- org.jline.console.CmdLine
-
public class CmdLine extends java.lang.Object
Represents a command line with its parsed components. This class stores information about a command line, including the original line, the part before and after the cursor, the parsed arguments, and the type of description that should be displayed for the command.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmdLine.DescriptionType
Enumeration specifying the type of description that should be displayed for the command.
-
Constructor Summary
Constructors Constructor Description CmdLine(java.lang.String line, java.lang.String head, java.lang.String tail, java.util.List<java.lang.String> args, CmdLine.DescriptionType descType)
Creates a new command line with the specified components.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>
getArgs()
Returns the parsed command line arguments.CmdLine.DescriptionType
getDescriptionType()
Returns the type of description that should be displayed for the command.java.lang.String
getHead()
Returns the part of the command line before the cursor, with method parameters and opening parenthesis removed.java.lang.String
getLine()
Returns the original command line.java.lang.String
getTail()
Returns the part of the command line after the cursor, with method parameters and closing parenthesis removed.
-
-
-
Constructor Detail
-
CmdLine
public CmdLine(java.lang.String line, java.lang.String head, java.lang.String tail, java.util.List<java.lang.String> args, CmdLine.DescriptionType descType)
Creates a new command line with the specified components.- Parameters:
line
- The original command linehead
- The part of the command line before the cursor, with method parameters and opening parenthesis removedtail
- The part of the command line after the cursor, with method parameters and closing parenthesis removedargs
- The parsed command line argumentsdescType
- The type of description that should be displayed for the command
-
-
Method Detail
-
getLine
public java.lang.String getLine()
Returns the original command line.- Returns:
- the original command line
-
getHead
public java.lang.String getHead()
Returns the part of the command line before the cursor, with method parameters and opening parenthesis removed.- Returns:
- the part of the command line before the cursor
-
getTail
public java.lang.String getTail()
Returns the part of the command line after the cursor, with method parameters and closing parenthesis removed.- Returns:
- the part of the command line after the cursor
-
getArgs
public java.util.List<java.lang.String> getArgs()
Returns the parsed command line arguments.- Returns:
- the parsed command line arguments
-
getDescriptionType
public CmdLine.DescriptionType getDescriptionType()
Returns the type of description that should be displayed for the command.- Returns:
- the type of description
-
-