org.apache.maven.plugin.AbstractMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation
Show all versions of virtdata-lib-realer Show documentation
With inspiration from other libraries
package org.apache.maven.plugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugin.logging.SystemStreamLog;
import java.util.Map;
/**
* Abstract class to provide most of the infrastructure required to implement a Mojo except for
* the execute method.
*
* The implementation should have a goal annotation in the class-level javadoc annotation:
*
* /**
* * @goal goalName
* */
*
*
* There are also a number of class-level javadoc annotations which can be used to control how and when the
* Mojo is executed:
*
*
*
*
*
* Descriptor Element
* Annotation
* Required?
* Notes
*
*
* goal
* @goal <goalName>
* Yes
* The name for the Mojo that users will reference from the command line to execute the Mojo directly,
* or inside a POM in order to provide Mojo-specific configuration.
*
*
* implementation
* none (detected)
* Yes
* The Mojo's fully-qualified class name (or script path in the case of non-Java Mojos).
*
*
* language
* none (detected)
* No. Default: java
* The implementation language for this Mojo (Java, beanshell, etc.).
*
*
* configurator
* @configurator <roleHint>
* No
* The configurator type to use when injecting parameter values into this Mojo. The value is normally
* deduced from the Mojo's implementation language, but can be specified to allow a custom
* ComponentConfigurator implementation to be used.
*
* NOTE: This will only be used in very special cases, using a highly controlled vocabulary of possible
* values. (Elements like this are why it's a good idea to use the descriptor tools.)
*
*
*
* phase
* @phase <phaseName>
* No
* Binds this Mojo to a particular phase of the standard build lifecycle, if specified.
*
* NOTE: This is only required if this Mojo is to participate in the standard build process.
*
*
*
* execute
* @execute [phase=<phaseName>|goal=<goalName>] [lifecycle=<lifecycleId>]
* No
* When this goal is invoked, it will first invoke a parallel lifecycle, ending at the given phase.
* If a goal is provided instead of a phase, that goal will be executed in isolation.
* The execution of either will not affect the current project, but instead make available the
* ${executedProject} expression if required. An alternate lifecycle can also be provided:
* for more information see the documentation on the
* build lifecycle.
*
*
*
* requiresDependencyResolution
* @requiresDependencyResolution <requiredScope>
* No
* Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be
* resolved before it can execute.
*
* NOTE: Currently supports compile, runtime, and test scopes.
*
*
*
* description
* none (detected)
* No
* The description of this Mojo's functionality. Using the toolset, this will be the class-level
* Javadoc description provided.
*
* NOTE: While this is not a required part of the Mojo specification, it SHOULD be provided to
* enable future tool support for browsing, etc. and for clarity.
*
*
*
* parameters
* N/A
* No
* Specifications for the parameters which this Mojo uses will be provided in parameter sub-elements
* in this section.
*
* NOTE: Parameters are discussed in more detail below.
*
*
*
*
* @see Guide to Developing Java Plugins
* @see Guide to Configuring Plug-ins
* @see Mojo API Specification
*
* @author Brett Porter
* @author jdcasey
* @author Vincent Siveton
* @version $Id: AbstractMojo.java 612012 2008-01-15 04:17:35Z vsiveton $
*/
public abstract class AbstractMojo
implements Mojo, ContextEnabled
{
/** Instance logger */
private Log log;
/** Plugin container context */
private Map pluginContext;
/**
* @see org.apache.maven.plugin.Mojo#setLog(org.apache.maven.plugin.logging.Log)
*/
public void setLog( Log log )
{
this.log = log;
}
/**
* Returns the logger that has been injected into this mojo. If no logger has been setup yet, a SystemStreamLog
* logger will be created and returned.
*
* Note:
* The logger returned by this method must not be cached in an instance field during the construction of the mojo.
* This would cause the mojo to use a wrongly configured default logger when being run by Maven. The proper logger
* gets injected by the Plexus container after the mojo has been constructed. Therefore, simply call this
* method directly whenever you need the logger, it is fast enough and needs no caching.
*
* @see org.apache.maven.plugin.Mojo#getLog()
*/
public Log getLog()
{
if ( log == null )
{
log = new SystemStreamLog();
}
return log;
}
/**
* @see org.apache.maven.plugin.ContextEnabled#getPluginContext()
*/
public Map getPluginContext()
{
return pluginContext;
}
/**
* @see org.apache.maven.plugin.ContextEnabled#setPluginContext(java.util.Map)
*/
public void setPluginContext( Map pluginContext )
{
this.pluginContext = pluginContext;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy