Package org.apache.maven.tools.plugin

Class ExtendedMojoDescriptor

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class ExtendedMojoDescriptor
extends org.apache.maven.plugin.descriptor.MojoDescriptor
    Extensions to MojoDescriptor not supported by Maven 3.2.5.
    Author:
    Kristian Rosenvold

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExtendedMojoDescriptor.AfterLink
      Holds after-link data from the @After annotation.

    • Field Summary

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

        MAVEN_PLUGIN, MULTI_PASS_EXEC_STRATEGY, SINGLE_PASS_EXEC_STRATEGY

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAfterLink​(ExtendedMojoDescriptor.AfterLink afterLink)
      Adds an after-link.
      boolean containsXhtmlTextValues()
      Indicates if the methods ComponentDescriptor.getDescription(), MojoDescriptor.getDeprecated(), Parameter.getDescription() and Parameter.getDeprecated() return XHTML values.
      boolean equals​(java.lang.Object obj)  
      java.util.List<ExtendedMojoDescriptor.AfterLink> getAfterLinks()
      Returns the after-links declared via @After annotations.
      int hashCode()  
      boolean isV4Api()  
      void setV4Api​(boolean v4Api)  

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

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

      • 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 Detail

      • ExtendedMojoDescriptor

        public ExtendedMojoDescriptor()

      • ExtendedMojoDescriptor

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

    • Method Detail

      • 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

      • isV4Api

        public boolean isV4Api()

      • setV4Api

        public void setV4Api​(boolean v4Api)

      • getAfterLinks

        public java.util.List<ExtendedMojoDescriptor.AfterLink> getAfterLinks()
        Returns the after-links declared via @After annotations.
        Returns:
        unmodifiable list of after-links, never null
        Since:
        4.0.0

      • addAfterLink

        public void addAfterLink​(ExtendedMojoDescriptor.AfterLink afterLink)
        Adds an after-link.
        Parameters:
        afterLink - the after-link to add
        Since:
        4.0.0

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.apache.maven.plugin.descriptor.MojoDescriptor

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class org.apache.maven.plugin.descriptor.MojoDescriptor