com.martiansoftware.nailgun

Class Alias

public class Alias extends Object implements 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(String name, String description, Class clazz)
Creates a new Alias with the specified properties.
Method Summary
intcompareTo(Object o)
Compares Alias names - no other fields are compared.
booleanequals(Object o)
Checks whether two Aliases have the same name.
ClassgetAliasedClass()
Returns the Class object providing a static main() or nailMain() method for this command.
StringgetDescription()
Returns a description for the aliased command
StringgetName()
Returns the name of the aliased command
inthashCode()

Constructor Detail

Alias

public Alias(String name, String description, 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

compareTo

public int compareTo(Object o)
Compares Alias names - no other fields are compared.

See Also: Comparable#compareTo(Object)

equals

public boolean equals(Object o)
Checks whether two Aliases have the same name. Does not compare any other fields.

Parameters: o the other Alias to check

Returns: true if the specified Alias has the same name as this Alias.

getAliasedClass

public 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.

getDescription

public String getDescription()
Returns a description for the aliased command

Returns: a description for the aliased command

getName

public String getName()
Returns the name of the aliased command

Returns: the name of the aliased command

hashCode

public int hashCode()

See Also: Object#hashCode()

© 2004, Martian Software, Inc.