org.jomc.mojo
Class AbstractModelShowMojo

Package class diagram package AbstractModelShowMojo
java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.jomc.mojo.AbstractJomcMojo
          extended by 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 3838 2011-10-08 20:15:41Z schulte2005 $
Author:
Christian Schulte

Field Summary
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractModelShowMojo()
          Creates a new AbstractModelShowMojo instance.
 
Method Summary
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.


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.