Package com.martiansoftware.nailgun

Class Alias

  • All Implemented Interfaces:
    java.lang.Comparable
    public class Alias
extends java.lang.Object
implements java.lang.Comparable
    Provides a means to map memorable, short names to classes in order to make the issuing of commands more convenient. For example, an Alias can map the "mycommand" command to the com.yourdomain.yourpackage.YourClass class. Obviously, it's a lot easier to type "ng mycommand" than the fully qualified class name.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Class clazz
      The class providing a main() or nailMain() method
      private java.lang.String description
      The alias description (may be used to provide help to users)
      private java.lang.String name
      The alias name

    • Constructor Summary

      Constructors 
      Constructor Description
      Alias​(java.lang.String name, java.lang.String description, java.lang.Class clazz)
      Creates a new Alias with the specified properties.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(java.lang.Object o)
      Compares Alias names - no other fields are compared.
      boolean equals​(java.lang.Object o)
      Checks whether two Aliases have the same name.
      java.lang.Class getAliasedClass()
      Returns the Class object providing a static main() or nailMain() method for this command.
      java.lang.String getDescription()
      Returns a description for the aliased command
      java.lang.String getName()
      Returns the name of the aliased command
      int hashCode()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • name

        private java.lang.String name
        The alias name

      • description

        private java.lang.String description
        The alias description (may be used to provide help to users)

      • clazz

        private java.lang.Class clazz
        The class providing a main() or nailMain() method

    • Constructor Detail

      • Alias

        public Alias​(java.lang.String name,
             java.lang.String description,
             java.lang.Class clazz)
        Creates a new Alias with the specified properties.
        Parameters:
        name - the alias name (short command)
        description - a description of the command
        clazz - the class implementing the command

    • Method Detail

      • getAliasedClass

        public java.lang.Class getAliasedClass()
        Returns the Class object providing a static main() or nailMain() method for this command.
        Returns:
        the Class object providing a static main() or nailMain() method for this command.

      • getName

        public java.lang.String getName()
        Returns the name of the aliased command
        Returns:
        the name of the aliased command

      • getDescription

        public java.lang.String getDescription()
        Returns a description for the aliased command
        Returns:
        a description for the aliased command

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()

      • equals

        public boolean equals​(java.lang.Object o)
        Checks whether two Aliases have the same name. Does not compare any other fields.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - the other Alias to check
        Returns:
        true if the specified Alias has the same name as this Alias.

      • compareTo

        public int compareTo​(java.lang.Object o)
        Compares Alias names - no other fields are compared.
        Specified by:
        compareTo in interface java.lang.Comparable
        See Also:
        Comparable.compareTo(Object)