Package org.aesh.readline.alias

Class AliasCompletion

java.lang.Object
org.aesh.readline.alias.AliasCompletion
All Implemented Interfaces:
org.aesh.readline.completion.Completion
public class AliasCompletion extends Object implements org.aesh.readline.completion.Completion
Completion provider for alias and unalias commands.
Author:
Ståle W. Pedersen

  • Constructor Summary

    Constructors
    Constructor
    Description
    AliasCompletion(AliasManager manager)
    Creates a new AliasCompletion with the specified alias manager.
    AliasCompletion(AliasManager manager, boolean includeAliasInCompletion)
    Creates a new AliasCompletion with the specified alias manager and completion behavior.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    complete(org.aesh.readline.completion.CompleteOperation completeOperation)
    Provides completion candidates for alias-related commands.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AliasCompletion

      public AliasCompletion(AliasManager manager)
      Creates a new AliasCompletion with the specified alias manager. By default, alias and unalias commands are included in completion suggestions.
      Parameters:
      manager - the alias manager used to retrieve alias names for completion

    • AliasCompletion

      public AliasCompletion(AliasManager manager, boolean includeAliasInCompletion)
      Creates a new AliasCompletion with the specified alias manager and completion behavior.
      Parameters:
      manager - the alias manager used to retrieve alias names for completion
      includeAliasInCompletion - if true, include alias and unalias commands in completion; if false, only provide alias name completions

  • Method Details

    • complete

      public void complete(org.aesh.readline.completion.CompleteOperation completeOperation)
      Provides completion candidates for alias-related commands. This method handles completion for:
      • Alias names matching the current input buffer
      • The 'alias' and 'unalias' commands (if enabled)
      • Arguments to 'alias' and 'unalias' commands
      • The '--help' option for alias commands
      Specified by:
      complete in interface org.aesh.readline.completion.Completion
      Parameters:
      completeOperation - the completion operation containing the current input and to which completion candidates will be added