Serialized Form

  • Package org.apache.maven.api.plugin.descriptor

    • Class org.apache.maven.api.plugin.descriptor.Dependency

      class Dependency extends Object implements Serializable

      • Serialized Fields

        • artifactId
          String artifactId
          The artifact id of the dependency.
        • groupId
          String groupId
          The group id of the dependency.
        • type
          String type
          The type of dependency.
        • version
          String version
          The version of the dependency.

    • Class org.apache.maven.api.plugin.descriptor.MojoDescriptor

      class MojoDescriptor extends Object implements Serializable

      • Serialized Fields

        • aggregator
          boolean aggregator
          Flags this Mojo to run it in a multi-module way, i.e. aggregate the build with the set of projects listed as modules.
        • configurator
          String configurator
          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.
        • dependencyCollection
          String dependencyCollection
          Flags this Mojo as requiring information about the dependencies that would make up the specified class path. As the name suggests, this is similar to requiresDependencyResolution and supports the same values. The important difference is this will not resolve the files for the dependencies, i.e. the artifacts associated with a Maven project can lack a file. As such, this annotation is meant for Mojos that only want to analyze the set of transitive dependencies, in particular during early lifecycle phases where full dependency resolution might fail due to projects which haven't been built yet.
        • dependencyResolution
          String dependencyResolution
          Flags this Mojo as requiring the dependencies in the specified class path to be resolved before it can execute: compile, runtime, test, compile+runtime (since Maven 3.0) or runtime+system (since Maven 3.0)
        • deprecated
          String deprecated
          Description with the reason of Mojo deprecation. Similar to Javadoc @deprecated This will trigger a warning when a user tries to use a Mojo marked as deprecated.
        • description
          String description
          The description of this Mojo's functionality.
        • directInvocationOnly
          boolean directInvocationOnly
          Flags this Mojo to be invoked directly only.
        • executeGoal
          String executeGoal
          Reference the invocation goal of the Mojo.
        • executeLifecycle
          String executeLifecycle
        • executePhase
          String executePhase
          Reference the invocation phase of the Mojo.
        • fullGoalName
          String fullGoalName
          the full goal name
        • goal
          String goal
          The goal 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.
        • id
          String id
          the id of the mojo, based on the goal name
        • implementation
          String implementation
          The Mojo's fully-qualified class name (or script path in the case of non-Java Mojos).
        • inheritedByDefault
          boolean inheritedByDefault
          Specify that the Mojo is inherited.
        • language
          String language
          The implementation language for this Mojo (java, beanshell, etc.).
        • onlineRequired
          boolean onlineRequired
          Flags this Mojo to require online mode for its operation.
        • parameters
          List<Parameter> parameters
        • phase
          String phase
          Defines a default phase to bind a Mojo execution to if the user does not explicitly set a phase in the POM.

          Note: This will not automagically make a Mojo run when the plugin declaration is added to the POM. It merely enables the user to omit the <phase> element from the surrounding <execution> element.

        • projectRequired
          boolean projectRequired
          Flags this Mojo to require running inside of a project.
        • resolutions
          List<Resolution> resolutions
        • since
          String since
          Specify the version when the Mojo was added to the API. Similar to Javadoc since.

    • Class org.apache.maven.api.plugin.descriptor.Parameter

      class Parameter extends Object implements Serializable

      • Serialized Fields

        • alias
          String alias
          Specifies an alias which can be used to configure this parameter from the POM. This is primarily useful to improve user-friendliness, where Mojo field names are not intuitive to the user or are otherwise not conducive to configuration via the POM.
        • defaultValue
          String defaultValue
          The default value, as an expression that will be evaluated at injection or run-time.
        • deprecated
          String deprecated
          Description with the reason of parameter deprecation. Similar to Javadoc @deprecated. This will trigger a warning when a user tries to configure a parameter marked as deprecated.
        • description
          String description
          The description of this parameter's use inside the Mojo.
        • editable
          boolean editable
          Specifies that this parameter can be configured directly by the user (as in the case of POM-specified configuration). This is useful when you want to force the user to use common POM elements rather than plugin configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you want the user to modify <build><finalName/></build> rather than specifying a value for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.
        • expression
          String expression
          Parameter expression, to let user override default value with a user property, system property or project property.
        • name
          String name
          The name of the parameter, to be used while configuring this parameter from the Mojo's declared defaults or from the POM.
        • required
          boolean required
          Whether this parameter is required for the Mojo to function. This is used to validate the configuration for a Mojo before it is injected, and before the Mojo is executed from some half-state.
        • since
          String since
          Specify the version when the parameter was added to the API. Similar to Javadoc since.
        • type
          String type
          The Java type for this parameter. This is used to validate the result of any expressions used to calculate the value which should be injected into the Mojo for this parameter.

    • Class org.apache.maven.api.plugin.descriptor.PluginDescriptor

      class PluginDescriptor extends Object implements Serializable

      • Serialized Fields

        • artifactId
          String artifactId
          The artifact id of the plugin.
        • description
          String description
          Description of the plugin.
        • goalPrefix
          String goalPrefix
        • groupId
          String groupId
          The group id of the plugin.
        • inheritedByDefault
          boolean inheritedByDefault
        • isolatedRealm
          boolean isolatedRealm
        • modelEncoding
          String modelEncoding
        • mojos
          List<MojoDescriptor> mojos
          Description of each Mojo provided by the plugin.
        • name
          String name
          Name of the plugin.
        • namespaceUri
          String namespaceUri
        • requiredJavaVersion
          String requiredJavaVersion
          A version range which specifies the supported Java versions. A version range can either use the usual mathematical syntax "[2.0.10,2.1.0),[3.0,)" or use a single version "2.2.1". The latter is a short form for "[2.2.1,)", i.e. denotes the minimum version required.
          Since:
          Maven 4.0.0-alpha-3
        • requiredMavenVersion
          String requiredMavenVersion
          A version range which specifies the supported Maven versions. A version range can either use the usual mathematical syntax "[2.0.10,2.1.0),[3.0,)" or use a single version "2.2.1". The latter is a short form for "[2.2.1,)", i.e. denotes the minimum version required. This value takes precedence over the POMs Maven prerequisite.
          Since:
          Maven 4.0.0-alpha-3
        • version
          String version
          The version of the plugin.

    • Class org.apache.maven.api.plugin.descriptor.Requirement

      class Requirement extends Object implements Serializable

      • Serialized Fields

        • fieldName
          String fieldName
          The field name which has this requirement.
        • role
          String role
        • roleHint
          String roleHint

    • Class org.apache.maven.api.plugin.descriptor.Resolution

      class Resolution extends Object implements Serializable

      • Serialized Fields

        • field
          String field
          the name of the field to be injected
        • pathScope
          String pathScope
          pathScope used to flatten dependencies
        • requestType
          String requestType
          either collect, flatten, or resolve

  • Package org.apache.maven.api.plugin.descriptor.lifecycle