Enum CompletionBehaviour
- java.lang.Object
-
- java.lang.Enum<CompletionBehaviour>
-
- com.github.rvesse.airline.help.cli.bash.CompletionBehaviour
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<CompletionBehaviour>
public enum CompletionBehaviour extends java.lang.Enum<CompletionBehaviour>
Possible completion behaviour for options/arguments
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AS_DIRECTORIES
Use the completions from the option meta-data (if any) but treat them as if they were directory names for additional completionAS_FILENAMES
Use the completions from the option meta-data (if any) but treat them as if they were filenames for additional completionCLI_COMMANDS
Commands from the CLI for which we are providing completionsDIRECTORIES
Directories, use standard directory name completion if no other completions applyFILENAMES
Filenames, use standard filename completion if no other completions applyNONE
None, either this is a flag option i.e.SYSTEM_COMMANDS
OS System commands
-
Constructor Summary
Constructors Modifier Constructor Description private
CompletionBehaviour()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CompletionBehaviour
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CompletionBehaviour[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final CompletionBehaviour NONE
None, either this is a flag option i.e. arity zero or you want to limit completions to those specified by the option meta-data
-
FILENAMES
public static final CompletionBehaviour FILENAMES
Filenames, use standard filename completion if no other completions apply
-
DIRECTORIES
public static final CompletionBehaviour DIRECTORIES
Directories, use standard directory name completion if no other completions apply
-
AS_FILENAMES
public static final CompletionBehaviour AS_FILENAMES
Use the completions from the option meta-data (if any) but treat them as if they were filenames for additional completion
-
AS_DIRECTORIES
public static final CompletionBehaviour AS_DIRECTORIES
Use the completions from the option meta-data (if any) but treat them as if they were directory names for additional completion
-
CLI_COMMANDS
public static final CompletionBehaviour CLI_COMMANDS
Commands from the CLI for which we are providing completions
-
SYSTEM_COMMANDS
public static final CompletionBehaviour SYSTEM_COMMANDS
OS System commands
-
-
Method Detail
-
values
public static CompletionBehaviour[] 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 (CompletionBehaviour c : CompletionBehaviour.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CompletionBehaviour 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
-
-