- java.lang.Object
-
- org.jline.shell.impl.DefaultAliasManager
-
- All Implemented Interfaces:
AliasManager
public class DefaultAliasManager extends java.lang.Object implements AliasManager
Default in-memory implementation ofAliasManagerwith optional file persistence.Aliases are stored in a
LinkedHashMapto preserve insertion order. When apersistFileis provided, aliases can be loaded from and saved to a simplename=expansionformat (one alias per line).The
expand(String)method supports parameter substitution in alias expansions using$1,$2, etc. for positional parameters, and$@for all remaining arguments. A recursion guard prevents infinite alias expansion loops.- Since:
- 4.0
-
-
Constructor Summary
Constructors Constructor Description DefaultAliasManager()Creates an in-memory alias manager with no persistence.DefaultAliasManager(java.nio.file.Path persistFile)Creates an alias manager with optional file persistence.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>aliases()Returns all defined aliases.java.lang.Stringexpand(java.lang.String line)Expands aliases in a command line string.java.lang.StringgetAlias(java.lang.String name)Returns the expansion for an alias.voidload()Loads aliases from persistent storage.booleanremoveAlias(java.lang.String name)Removes an alias.voidsave()Saves aliases to persistent storage.voidsetAlias(java.lang.String name, java.lang.String expansion)Defines or redefines an alias.
-
-
-
Constructor Detail
-
DefaultAliasManager
public DefaultAliasManager()
Creates an in-memory alias manager with no persistence.
-
DefaultAliasManager
public DefaultAliasManager(java.nio.file.Path persistFile)
Creates an alias manager with optional file persistence.The persistence file uses a simple
name=expansionformat, one alias per line. Lines starting with#are treated as comments.- Parameters:
persistFile- the file to persist aliases to, or null for in-memory only
-
-
Method Detail
-
setAlias
public void setAlias(java.lang.String name, java.lang.String expansion)Description copied from interface:AliasManagerDefines or redefines an alias.- Specified by:
setAliasin interfaceAliasManager- Parameters:
name- the alias nameexpansion- the expansion text
-
removeAlias
public boolean removeAlias(java.lang.String name)
Description copied from interface:AliasManagerRemoves an alias.- Specified by:
removeAliasin interfaceAliasManager- Parameters:
name- the alias name- Returns:
- true if the alias existed and was removed
-
getAlias
public java.lang.String getAlias(java.lang.String name)
Description copied from interface:AliasManagerReturns the expansion for an alias.- Specified by:
getAliasin interfaceAliasManager- Parameters:
name- the alias name- Returns:
- the expansion, or null if no alias with that name exists
-
aliases
public java.util.Map<java.lang.String,java.lang.String> aliases()
Description copied from interface:AliasManagerReturns all defined aliases.- Specified by:
aliasesin interfaceAliasManager- Returns:
- an unmodifiable map of alias name to expansion
-
expand
public java.lang.String expand(java.lang.String line)
Description copied from interface:AliasManagerExpands aliases in a command line string.The first word of the line is checked against defined aliases. If it matches, the alias expansion is substituted. Supports parameter markers (
$1,$2,$@) in expansions. Includes a recursion guard to prevent infinite expansion.- Specified by:
expandin interfaceAliasManager- Parameters:
line- the command line to expand- Returns:
- the expanded command line
-
load
public void load() throws java.io.IOExceptionDescription copied from interface:AliasManagerLoads aliases from persistent storage.The default implementation does nothing.
- Specified by:
loadin interfaceAliasManager- Throws:
java.io.IOException- if loading fails
-
save
public void save() throws java.io.IOExceptionDescription copied from interface:AliasManagerSaves aliases to persistent storage.The default implementation does nothing.
- Specified by:
savein interfaceAliasManager- Throws:
java.io.IOException- if saving fails
-
-