org.sonatype.gshell.command.descriptor
Class CommandSetDescriptor

java.lang.Object
  org.sonatype.gshell.command.descriptor.CommandSetDescriptor

All Implemented Interfaces:

Serializable, Comparable<CommandSetDescriptor>

public class CommandSetDescriptor
extends Object
implements Comparable<CommandSetDescriptor>, Serializable

Command set descriptor.

Since:

2.1 .

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

CommandSetDescriptor()

Method Summary

void	addCommand(CommandDescriptor commandDescriptor) Method addCommand.
void	addHelpPage(HelpPageDescriptor helpPageDescriptor) Method addHelpPage.
void	breakCommandDescriptorAssociation(CommandDescriptor commandDescriptor) Method breakCommandDescriptorAssociation.
int	compareTo(CommandSetDescriptor target)
void	createCommandDescriptorAssociation(CommandDescriptor commandDescriptor) Method createCommandDescriptorAssociation.
boolean	equals(Object other) Method equals.
int	getAutoRegisterPriority() Get the autoRegisterPriority field.
List<CommandDescriptor>	getCommands() Method getCommands.
List<HelpPageDescriptor>	getHelpPages() Method getHelpPages.
String	getId() Get the id field.
int	hashCode() Method hashCode.
boolean	isEnabled() Get the enabled field.
void	removeCommand(CommandDescriptor commandDescriptor) Method removeCommand.
void	removeHelpPage(HelpPageDescriptor helpPageDescriptor) Method removeHelpPage.
void	setAutoRegisterPriority(int autoRegisterPriority) Set the autoRegisterPriority field.
void	setCommands(List<CommandDescriptor> commands) Set the commands field.
void	setEnabled(boolean enabled) Set the enabled field.
void	setHelpPages(List<HelpPageDescriptor> helpPages) Set the helpPages field.
void	setId(String id) Set the id field.
String	toString() Method toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandSetDescriptor

public CommandSetDescriptor()

Method Detail

addCommand

public void addCommand(CommandDescriptor commandDescriptor)

Method addCommand.

Parameters:

commandDescriptor -

addHelpPage

public void addHelpPage(HelpPageDescriptor helpPageDescriptor)

Method addHelpPage.

Parameters:

helpPageDescriptor -

breakCommandDescriptorAssociation

public void breakCommandDescriptorAssociation(CommandDescriptor commandDescriptor)

Method breakCommandDescriptorAssociation.

Parameters:

commandDescriptor -

createCommandDescriptorAssociation

public void createCommandDescriptorAssociation(CommandDescriptor commandDescriptor)

Method createCommandDescriptorAssociation.

Parameters:

commandDescriptor -

equals

public boolean equals(Object other)

Method equals.

Overrides:

equals in class Object

Parameters:

other -

Returns:

boolean

getAutoRegisterPriority

public int getAutoRegisterPriority()

Get the autoRegisterPriority field.

Returns:

int

getCommands

public List<CommandDescriptor> getCommands()

Method getCommands.

Returns:

List

getHelpPages

public List<HelpPageDescriptor> getHelpPages()

Method getHelpPages.

Returns:

List

getId

public String getId()

Get the id field.

Returns:

String

hashCode

public int hashCode()

Method hashCode.

Overrides:

hashCode in class Object

Returns:

int

isEnabled

public boolean isEnabled()

Get the enabled field.

Returns:

boolean

removeCommand

public void removeCommand(CommandDescriptor commandDescriptor)

Method removeCommand.

Parameters:

commandDescriptor -

removeHelpPage

public void removeHelpPage(HelpPageDescriptor helpPageDescriptor)

Method removeHelpPage.

Parameters:

helpPageDescriptor -

setAutoRegisterPriority

public void setAutoRegisterPriority(int autoRegisterPriority)

Set the autoRegisterPriority field.

Parameters:

autoRegisterPriority -

setCommands

public void setCommands(List<CommandDescriptor> commands)

Set the commands field.

Parameters:

commands -

setEnabled

public void setEnabled(boolean enabled)

Set the enabled field.

Parameters:

enabled -

setHelpPages

public void setHelpPages(List<HelpPageDescriptor> helpPages)

Set the helpPages field.

Parameters:

helpPages -

setId

public void setId(String id)

Set the id field.

Parameters:

id -

toString

public String toString()

Method toString.

Overrides:

toString in class Object

Returns:

String

compareTo

public int compareTo(CommandSetDescriptor target)

Specified by:

compareTo in interface Comparable<CommandSetDescriptor>