Class AliasManager

java.lang.Object
com.martiansoftware.nailgun.AliasManager
public class AliasManager extends Object
An AliasManager is used to store and lookup command Aliases by name. See Alias for more details.

  • Field Details

    • aliases

      private Map aliases
      actual alias storage

  • Constructor Details

    • AliasManager

      public AliasManager()
      Creates a new AliasManager, populating it with default Aliases.

  • Method Details

    • loadFromProperties

      public void loadFromProperties(Properties properties)
      Loads Aliases from a java.util.Properties file located at the specified URL. The properties must be of the form: 
      [alias name]=[fully qualified classname]
      each of which may have an optional 
      [alias name].desc=[alias description]
      For example, to create an alias called " myprog" for class com.mydomain.myapp.MyProg, the following properties would be defined: 
      myprog=com.mydomain.myapp.MyProg
myprog.desc=Runs my program.
      Parameters:
      properties - the Properties to load.

    • addAlias

      public void addAlias(Alias alias)
      Adds an Alias, replacing any previous entries with the same name.
      Parameters:
      alias - the Alias to add

    • getAliases

      public Set getAliases()
      Returns a Set that is a snapshot of the Alias list. Modifications to this Set will not impact the AliasManager in any way.
      Returns:
      a Set that is a snapshot of the Alias list.

    • removeAlias

      public void removeAlias(String aliasName)
      Removes the Alias with the specified name from the AliasManager. If no such Alias exists in this AliasManager, this method has no effect.
      Parameters:
      aliasName - the name of the Alias to remove

    • getAlias

      public Alias getAlias(String aliasName)
      Returns the Alias with the specified name
      Parameters:
      aliasName - the name of the Alias to retrieve
      Returns:
      the requested Alias, or null if no such Alias is defined in this AliasManager.