org.jomc.mojo

Class AbstractModelShowMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.jomc.mojo.AbstractJomcMojo

org.jomc.mojo.AbstractModelShowMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

MainInstanceShowMojo, MainModelShowMojo, MainSpecificationShowMojo, TestInstanceShowMojo, TestModelShowMojo, TestSpecificationShowMojo

public abstract class AbstractModelShowMojo
extends AbstractJomcMojo

Base class for displaying and dumping model objects.

Since:

1.1

Version:

$JOMC: AbstractModelShowMojo.java 4613 2012-09-22 10:07:08Z schulte $

Author:

Christian Schulte

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	executeTool() Executes this tool.
protected abstract ClassLoader	getDisplayClassLoader() Gets the class loader to use for displaying or dumping model objects.
protected abstract Model	getDisplayModel(ModelContext modelContext) Gets the model to display or dump.

Methods inherited from class org.jomc.mojo.AbstractJomcMojo

assertValidParameters, assertValidResources, createClassFileProcessor, createJomcTool, createModelContext, createObject, createResourceFileProcessor, createSourceFileProcessor, execute, getAbsoluteFile, getDirectory, getExecutionStrategy, getGoal, getMainClassLoader, getMainClasspathElements, getMavenProject, getMavenSession, getModel, getModel, getModuleName, getOutputDirectory, getProperties, getReportOutputDirectory, getResource, getSessionDirectory, getSourceDirectory, getTestClassLoader, getTestClasspathElements, getTestModuleName, getTestOutputDirectory, getTestSourceDirectory, getTransformer, isClassProcessingEnabled, isExecutionPermitted, isLoggable, isModelObjectClasspathResolutionEnabled, isModelProcessingEnabled, isResourceProcessingEnabled, isSourceProcessingEnabled, isVerbose, log, log, logMissingModule, logProcessingModel, logProcessingModule, logSeparator, logSeparator, logToolSuccess, setClassProcessingEnabled, setModelObjectClasspathResolutionEnabled, setModelProcessingEnabled, setResourceProcessingEnabled, setSourceProcessingEnabled, setupJomcTool, setupModelContext, setVerbose

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractModelShowMojo

public AbstractModelShowMojo()

Creates a new AbstractModelShowMojo instance.

Method Detail

executeTool

protected final void executeTool()
                          throws Exception

Description copied from class: AbstractJomcMojo

Executes this tool.

Specified by:

executeTool in class AbstractJomcMojo

Throws:

Exception - if execution of this tool fails.

getDisplayModel

protected abstract Model getDisplayModel(ModelContext modelContext)
                                  throws MojoExecutionException

Gets the model to display or dump.

Parameters:

modelContext - The model context to use for getting the model.

Returns:

The model to display or dump.

Throws:

MojoExecutionException - if getting the model fails.

getDisplayClassLoader

protected abstract ClassLoader getDisplayClassLoader()
                                              throws MojoExecutionException

Gets the class loader to use for displaying or dumping model objects.

Returns:

The class loader to use for displaying or dumping model objects.

Throws:

MojoExecutionException - if getting the class loader fails.