org.jomc.cli
Interface Command

Package class diagram package Command
All Known Implementing Classes:
AbstractClassFileProcessorCommand, AbstractCommand, AbstractJomcToolCommand, AbstractModelCommand, AbstractModletCommand, AbstractResourceFileProcessorCommand, AbstractSourceFileProcessorCommand, CommitClassesCommand, GenerateResourcesCommand, ManageSourcesCommand, MergeModletsCommand, MergeModulesCommand, ShowModelCommand, ValidateClassesCommand, ValidateModelCommand

@Generated(value="org.jomc.tools.SourceFileProcessor 1.2.3",
           comments="See http://jomc.sourceforge.net/jomc/1.2/jomc-tools-1.2.3")
public interface Command

Command.

Identifier:
JOMC CLI Command
Multiplicity:
Many
Scope:
None

Version:
1.0
Author:
Christian Schulte 1.0
See Also:
getObject(Command[].class), getObject(Command.class, "implementation name"), ObjectManagerFactory

Nested Class Summary
static interface Command.Listener
          Listener interface.
 
Field Summary
static int STATUS_FAILURE
          Status code when the command failed.
static int STATUS_SUCCESS
          Status code when the command completed successfully.
 
Method Summary
 int execute(CommandLine commandLine)
          Executes the command.
 String getAbbreviatedName()
          Gets the abbreviated name of the command.
 List<Command.Listener> getListeners()
          Gets the list of registered listeners.
 Level getLogLevel()
          Gets the log level of the instance.
 String getLongDescription(Locale locale)
          Gets the long description of the command.
 String getName()
          Gets the name of the command.
 Options getOptions()
          Gets the options of the command.
 String getShortDescription(Locale locale)
          Gets the short description of the command.
 void setLogLevel(Level value)
          Sets the log level of the instance.
 

Field Detail

STATUS_SUCCESS

static final int STATUS_SUCCESS
Status code when the command completed successfully.

See Also:
Constant Field Values

STATUS_FAILURE

static final int STATUS_FAILURE
Status code when the command failed.

See Also:
Constant Field Values
Method Detail

getListeners

List<Command.Listener> getListeners()
Gets the list of registered listeners.

Returns:
The list of registered listeners.

getLogLevel

Level getLogLevel()
Gets the log level of the instance.

Returns:
The log level of the instance.
See Also:
setLogLevel(java.util.logging.Level)

setLogLevel

void setLogLevel(Level value)
Sets the log level of the instance.

Parameters:
value - The new log level of the instance or null.
See Also:
getLogLevel()

getName

String getName()
Gets the name of the command.

Returns:
The name of the command.

getAbbreviatedName

String getAbbreviatedName()
Gets the abbreviated name of the command.

Returns:
The abbreviated name of the command.

getShortDescription

String getShortDescription(Locale locale)
                           throws NullPointerException
Gets the short description of the command.

Parameters:
locale - The locale of the short description to return.
Returns:
The short description of the command.
Throws:
NullPointerException - if locale is null.

getLongDescription

String getLongDescription(Locale locale)
                          throws NullPointerException
Gets the long description of the command.

Parameters:
locale - The locale of the long description to return.
Returns:
The long description of the command.
Throws:
NullPointerException - if locale is null.

getOptions

Options getOptions()
Gets the options of the command.

Returns:
The options of the command.

execute

int execute(CommandLine commandLine)
            throws NullPointerException
Executes the command.

Parameters:
commandLine - Command line to execute.
Returns:
The status code to report.
Throws:
NullPointerException - if commandLine is null.
See Also:
STATUS_SUCCESS, STATUS_FAILURE


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.