Package org.apache.maven.tools.plugin

Class ExtendedMojoDescriptor

java.lang.Object
org.codehaus.plexus.component.repository.ComponentDescriptor<org.apache.maven.plugin.Mojo>
org.apache.maven.plugin.descriptor.MojoDescriptor
org.apache.maven.tools.plugin.ExtendedMojoDescriptor
All Implemented Interfaces:
Cloneable
public class ExtendedMojoDescriptor extends org.apache.maven.plugin.descriptor.MojoDescriptor
Extensions to MojoDescriptor added to Maven 3, then are not available when run under Maven2.
Author:
Kristian Rosenvold

  • Field Summary

    Fields inherited from class org.apache.maven.plugin.descriptor.MojoDescriptor

    MAVEN_PLUGIN, MULTI_PASS_EXEC_STRATEGY, SINGLE_PASS_EXEC_STRATEGY

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExtendedMojoDescriptor()
     
    ExtendedMojoDescriptor(boolean containsXhtmlTextValues)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsXhtmlTextValues()
    Indicates if the methods ComponentDescriptor.getDescription(), MojoDescriptor.getDeprecated(), Parameter.getDescription() and Parameter.getDeprecated() return XHTML values.
    String
    getDependencyCollectionRequired()
     
    boolean
    isThreadSafe()
     
    void
    setDependencyCollectionRequired(String requiresDependencyCollection)
     
    void
    setThreadSafe(boolean threadSafe)
     

    Methods inherited from class org.apache.maven.plugin.descriptor.MojoDescriptor

    addParameter, alwaysExecute, clone, equals, getComponentType, getDependencyResolutionRequired, getDeprecated, getExecuteGoal, getExecuteLifecycle, getExecutePhase, getExecutionStrategy, getFullGoalName, getGoal, getId, getLanguage, getMojoConfiguration, getParameterMap, getParameters, getPhase, getPluginDescriptor, getRole, getRoleHint, getSince, hashCode, isAggregator, isDependencyResolutionRequired, isDirectInvocationOnly, isForking, isInheritedByDefault, isOnlineRequired, isProjectRequired, isRequiresReports, requiresOnline, setAggregator, setDependencyResolutionRequired, setDeprecated, setDirectInvocationOnly, setExecuteGoal, setExecuteLifecycle, setExecutePhase, setExecutionStrategy, setGoal, setInheritedByDefault, setLanguage, setMojoConfiguration, setOnlineRequired, setParameters, setPhase, setPluginDescriptor, setProjectRequired, setRequiresReports, setSince

    Methods inherited from class org.codehaus.plexus.component.repository.ComponentDescriptor

    addRequirement, getAlias, getComponentComposer, getComponentConfigurator, getComponentFactory, getComponentProfile, getConfiguration, getDescription, getHumanReadableKey, getImplementation, getImplementationClass, getInstantiationStrategy, getLifecycleHandler, getRealm, getRequirements, getRoleClass, getVersion, hasConfiguration, isIsolatedRealm, setAlias, setComponentComposer, setComponentConfigurator, setComponentFactory, setComponentProfile, setComponentType, setConfiguration, setDescription, setImplementation, setImplementationClass, setInstantiationStrategy, setIsolatedRealm, setLifecycleHandler, setRealm, setRole, setRoleClass, setRoleHint, setVersion, toString

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ExtendedMojoDescriptor

      public ExtendedMojoDescriptor()

    • ExtendedMojoDescriptor

      public ExtendedMojoDescriptor(boolean containsXhtmlTextValues)
      Parameters:
      containsXhtmlTextValues -
      Since:
      3.7.0

  • Method Details

    • isThreadSafe

      public boolean isThreadSafe()
      Overrides:
      isThreadSafe in class org.apache.maven.plugin.descriptor.MojoDescriptor

    • setThreadSafe

      public void setThreadSafe(boolean threadSafe)
      Overrides:
      setThreadSafe in class org.apache.maven.plugin.descriptor.MojoDescriptor

    • getDependencyCollectionRequired

      public String getDependencyCollectionRequired()
      Overrides:
      getDependencyCollectionRequired in class org.apache.maven.plugin.descriptor.MojoDescriptor

    • setDependencyCollectionRequired

      public void setDependencyCollectionRequired(String requiresDependencyCollection)
      Overrides:
      setDependencyCollectionRequired in class org.apache.maven.plugin.descriptor.MojoDescriptor

    • containsXhtmlTextValues

      public boolean containsXhtmlTextValues()
      Indicates if the methods ComponentDescriptor.getDescription(), MojoDescriptor.getDeprecated(), Parameter.getDescription() and Parameter.getDeprecated() return XHTML values.
      Returns:
      true if aforementioned methods return XHTML values, if false those values contain javadoc (HTML + custom javadoc tags) (for legacy extractors)
      Since:
      3.7.0