Package org.jline.widget
Enum TailTipWidgets.TipType
- java.lang.Object
-
- java.lang.Enum<TailTipWidgets.TipType>
-
- org.jline.widget.TailTipWidgets.TipType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TailTipWidgets.TipType>
- Enclosing class:
- TailTipWidgets
public static enum TailTipWidgets.TipType extends java.lang.Enum<TailTipWidgets.TipType>
Enumeration specifying the type of suggestions to display.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description COMBINED
Prepare command line suggestions using either a command's positional argument descriptions if they exist, or command completer data if no argument descriptions are available.COMPLETER
Prepare command line suggestions using a command's completer data.TAIL_TIP
Prepare command line suggestions using a command's positional argument descriptions.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TailTipWidgets.TipType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TailTipWidgets.TipType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
TAIL_TIP
public static final TailTipWidgets.TipType TAIL_TIP
Prepare command line suggestions using a command's positional argument descriptions. This type focuses on showing information about the expected arguments at the current position.
-
COMPLETER
public static final TailTipWidgets.TipType COMPLETER
Prepare command line suggestions using a command's completer data. This type focuses on showing possible completions based on the current input.
-
COMBINED
public static final TailTipWidgets.TipType COMBINED
Prepare command line suggestions using either a command's positional argument descriptions if they exist, or command completer data if no argument descriptions are available. This type provides the most comprehensive suggestions by combining both approaches.
-
-
Method Detail
-
values
public static TailTipWidgets.TipType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TailTipWidgets.TipType c : TailTipWidgets.TipType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TailTipWidgets.TipType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-