org.jomc.cli.commands

Class AbstractJomcToolCommand

java.lang.Object

org.jomc.cli.commands.AbstractCommand

org.jomc.cli.commands.AbstractModletCommand

org.jomc.cli.commands.AbstractModelCommand

org.jomc.cli.commands.AbstractJomcToolCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AbstractClassFileProcessorCommand, AbstractResourceFileProcessorCommand, AbstractSourceFileProcessorCommand

public abstract class AbstractJomcToolCommand
extends AbstractModelCommand

JomcTool based command implementation.

Author:

Christian Schulte

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

Constructors

Constructor and Description
AbstractJomcToolCommand() Creates a new AbstractJomcToolCommand instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected <T extends JomcTool> T	createJomcTool(String className, Class<T> type, CommandLine commandLine) Creates a new JomcTool object for a given class name and type.
protected <T> T	createObject(String className, Class<T> type) Creates a new object for a given class name and type.
protected org.jomc.model.Implementation	getImplementation(CommandLine commandLine, Model model) Gets the implementation to process from a given model.
protected Locale	getLocale(CommandLine commandLine) Gets a locale from a command line.
protected org.jomc.model.Module	getModule(CommandLine commandLine, Model model) Gets the module to process from a given model.
Options	getOptions() Gets the options of the command.
protected org.jomc.model.Specification	getSpecification(CommandLine commandLine, Model model) Gets the specification to process from a given model.
protected boolean	isModulesProcessingRequested(CommandLine commandLine) Gets a flag indicating that all modules are requested to be processed.

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, executeCommand, getDefaultLogLevel, getExecutorService, getListeners, getLogLevel, isLoggable, log, postExecuteCommand, preExecuteCommand, setDefaultLogLevel, setLogLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jomc.cli.Command

getAbbreviatedName, getLongDescription, getName, getShortDescription

Constructor Detail

AbstractJomcToolCommand

public AbstractJomcToolCommand()

Creates a new AbstractJomcToolCommand instance.

Method Detail

getOptions

public Options getOptions()

Description copied from interface: Command

Gets the options of the command.

Specified by:

getOptions in interface Command

Overrides:

getOptions in class AbstractModelCommand

Returns:

The options of the command.

createObject

protected <T> T createObject(String className,
                 Class<T> type)
                  throws CommandExecutionException

Creates a new object for a given class name and type.

Type Parameters:

T - The type of the object to create.

Parameters:

className - The name of the class to create an object of.

type - The class of the type of object to create.

Returns:

A new instance of the class with name className.

Throws:

NullPointerException - if className or type is null.

CommandExecutionException - if creating a new object fails.

createJomcTool

protected <T extends JomcTool> T createJomcTool(String className,
                                    Class<T> type,
                                    CommandLine commandLine)
                                     throws CommandExecutionException

Creates a new JomcTool object for a given class name and type.

Type Parameters:

T - The type of the object to create.

Parameters:

commandLine - The CommandLine to configure the new JomcTool object with.

className - The name of the class to create an object of.

type - The class of the type of object to create.

Returns:

A new instance of the class with name className configured using commandLine.

Throws:

NullPointerException - if commandLine, className or type is null.

CommandExecutionException - if creating a new object fails.

See Also:

createObject(java.lang.String, java.lang.Class)

getSpecification

protected final org.jomc.model.Specification getSpecification(CommandLine commandLine,
                                            Model model)

Gets the specification to process from a given model.

Parameters:

commandLine - The command line specifying the specification to process.

model - The model to get the specification to process from.

Returns:

The specification to process or null.

Throws:

NullPointerException - if commandLine or model is null.

getImplementation

protected final org.jomc.model.Implementation getImplementation(CommandLine commandLine,
                                              Model model)

Gets the implementation to process from a given model.

Parameters:

commandLine - The command line specifying the implementation to process.

model - The model to get the implementation to process from.

Returns:

The implementation to process or null.

Throws:

NullPointerException - if commandLine or model is null.

getModule

protected final org.jomc.model.Module getModule(CommandLine commandLine,
                              Model model)

Gets the module to process from a given model.

Parameters:

commandLine - The command line specifying the implementation to process.

model - The model to get the module to process from.

Returns:

The module to process or null.

Throws:

NullPointerException - if model is null.

isModulesProcessingRequested

protected final boolean isModulesProcessingRequested(CommandLine commandLine)

Gets a flag indicating that all modules are requested to be processed.

Parameters:

commandLine - The command line to process.

Returns:

true, if processing of all modules is requested; false, else.

Throws:

NullPointerException - if commandLine is null.

See Also:

getSpecification(org.apache.commons.cli.CommandLine, org.jomc.modlet.Model), getImplementation(org.apache.commons.cli.CommandLine, org.jomc.modlet.Model), getModule(org.apache.commons.cli.CommandLine, org.jomc.modlet.Model)

getLocale

protected final Locale getLocale(CommandLine commandLine)

Gets a locale from a command line.

Parameters:

commandLine - The command line to get a locale from.

Returns:

The locale from commandLine or null, if commandLine does not hold options specifying a locale.