com.martiansoftware.nailgun
Class Alias

java.lang.Object
  extended by com.martiansoftware.nailgun.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.

Author:
Marty Lamb

Constructor Summary
Alias(java.lang.String name, java.lang.String description, java.lang.Class clazz)
          Creates a new Alias with the specified properties.
 
Method Summary
 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
getClass, notify, notifyAll, toString, wait, wait, wait
 

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)


© 2004, Martian Software, Inc.