org.jomc.cli.commands
Class AbstractSourceFileProcessorCommand

Package class diagram package AbstractSourceFileProcessorCommand
java.lang.Object
  extended by org.jomc.cli.commands.AbstractCommand
      extended by org.jomc.cli.commands.AbstractModletCommand
          extended by org.jomc.cli.commands.AbstractModelCommand
              extended by org.jomc.cli.commands.AbstractJomcToolCommand
                  extended by org.jomc.cli.commands.AbstractSourceFileProcessorCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
ManageSourcesCommand

@Generated(value="org.jomc.tools.SourceFileProcessor 1.2.3",
           comments="See http://jomc.sourceforge.net/jomc/1.2/jomc-tools-1.2.3")
public abstract class AbstractSourceFileProcessorCommand
extends AbstractJomcToolCommand

JOMC CLI SourceFileProcessor based command implementation.

Identifier:
JOMC CLI SourceFileProcessor Command
Name:
JOMC CLI SourceFileProcessor Command
Specifications:
JOMC CLI Command @ 1.0
Abstract:
Yes
Final:
No
Stateless:
No

Version:
1.2.7
Author:
Christian Schulte 1.2

Nested Class Summary
 
Nested classes/interfaces inherited from class org.jomc.cli.commands.AbstractModletCommand
AbstractModletCommand.CommandLineClassLoader
 
Nested classes/interfaces inherited from interface org.jomc.cli.Command
Command.Listener
 
Field Summary
 
Fields inherited from interface org.jomc.cli.Command
STATUS_FAILURE, STATUS_SUCCESS
 
Constructor Summary
AbstractSourceFileProcessorCommand()
          Creates a new AbstractSourceFileProcessorCommand instance.
 
Method Summary
protected  SourceFileProcessor createSourceFileProcessor(CommandLine commandLine)
          Creates a new SourceFileProcessor instance taking a command line.
protected  void executeCommand(CommandLine commandLine)
          Called by the execute method prior to the postExecuteCommand method.
 Options getOptions()
          Gets the options of the command.
protected abstract  void processSourceFiles(CommandLine commandLine)
          Processes source files.
 
Methods inherited from class org.jomc.cli.commands.AbstractJomcToolCommand
createJomcTool, createObject, getImplementation, getLocale, getModule, getSpecification, isModulesProcessingRequested, postExecuteCommand
 
Methods inherited from class org.jomc.cli.commands.AbstractModelCommand
createModelContext, getModel
 
Methods inherited from class org.jomc.cli.commands.AbstractModletCommand
createTransformer, getDocumentFiles, getModel, log
 
Methods inherited from class org.jomc.cli.commands.AbstractCommand
execute, getAbbreviatedName, getDefaultLogLevel, getExceptionMessage, getListeners, getLogLevel, getLongDescription, getName, getShortDescription, isLoggable, log, preExecuteCommand, setDefaultLogLevel, setLogLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractSourceFileProcessorCommand

@Generated(value="org.jomc.tools.SourceFileProcessor 1.2.3",
           comments="See http://jomc.sourceforge.net/jomc/1.2/jomc-tools-1.2.3")
public AbstractSourceFileProcessorCommand()
Creates a new AbstractSourceFileProcessorCommand instance.

Method Detail

createSourceFileProcessor

protected SourceFileProcessor createSourceFileProcessor(CommandLine commandLine)
                                                 throws CommandExecutionException
Creates a new SourceFileProcessor instance taking a command line.

Parameters:
commandLine - The command line to process.
Returns:
A new SourceFileProcessor instance as specified by the given command line or null, if creating a new instance fails.
Throws:
NullPointerException - if commandLine is null.
CommandExecutionException - if creating a new instance fails.

executeCommand

protected final void executeCommand(CommandLine commandLine)
                             throws CommandExecutionException
Called by the execute method prior to the postExecuteCommand method.

Specified by:
executeCommand in class AbstractCommand
Parameters:
commandLine - The command line to execute.
Throws:
CommandExecutionException - if executing the command fails.
See Also:
AbstractCommand.execute(org.apache.commons.cli.CommandLine)

processSourceFiles

protected abstract void processSourceFiles(CommandLine commandLine)
                                    throws CommandExecutionException
Processes source files.

Parameters:
commandLine - The command line to execute.
Throws:
CommandExecutionException - if processing source files fails.

getOptions

@Generated(value="org.jomc.tools.SourceFileProcessor 1.2.3",
           comments="See http://jomc.sourceforge.net/jomc/1.2/jomc-tools-1.2.3")
public Options getOptions()
Gets the options of the command.

Options:

Specification Implementation
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Classpath Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Country Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Default Template Profile Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Documents Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Implementation Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Indentation String Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Input Encoding Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Language Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Line Separator Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Locale Variant Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI ModelContextFactory Class Name Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Model Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Modlet Location Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Modlet Schema System Id Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Module Location Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Module Name Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI No Classpath Resolution Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI No Model Processing Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI No Model Resource Validation Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI No Modlet Resource Validation Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI No Source File Processing Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Output Encoding Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Platform Provider Location Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Provider Location Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Source Directory Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI SourceFileProcessor Class Name Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Specification Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Template Encoding Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Template Location Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Template Profile Option
JOMC CLI Command Option (org.apache.commons.cli.Option) @ 1.2 JOMC CLI Transformer Location Option

Specified by:
getOptions in interface Command
Overrides:
getOptions in class AbstractJomcToolCommand
Returns:
The options of the command.


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.