Index (Maven Plugin Metadata Model 3.6.2 API)

A C G I L M O P R S T W
All Classes|All Packages|Constant Field Values|Serialized Form

A

addComponent(Component) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Method addComponent.
addMojo(Mojo) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata: Method addMojo.
addParameter(Parameter) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Method addParameter.

C

Component - Class in org.apache.maven.tools.plugin.extractor.model: A reference to a plexus component, assumed to be available to the plugin container.
Component() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Component
contentTransformer - Variable in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader: Field contentTransformer.

G

getAddDefaultEntities() - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader: Returns the state of the "add default entities" flag.
getAlias() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get an alternate name for the parameter.
getCall() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get the target/method within the script to call when this mojo executes.
getComponents() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Method getComponents.
getDefaultValue() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get an expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system.
getDeprecation() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get a deprecation message for this mojo parameter.
getDeprecation() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get a deprecation message for this mojo parameter.
getDescription() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get the description for this parameter.
getDescription() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get the description for this parameter.
getExecution() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get information about a sub-execution of the Maven lifecycle which should be processed.
getExpression() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get the command-line reference to this parameter.
getGoal() - Method in class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution: Get a goal, not attached to a lifecycle phase, which should be executed ahead of this mojo.
getGoal() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get the name of the goal used to invoke this mojo.
getHint() - Method in class org.apache.maven.tools.plugin.extractor.model.Component: Get the role-hint to lookup.
getLifecycle() - Method in class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution: Get the name of the overlay to apply to the sub-lifecycle before executing it.
getMetadataFile() - Method in exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
getModelEncoding() - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata: Get the modelEncoding field.
getMojos() - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata: Method getMojos.
getName() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get the parameter name.
getOriginalMessage() - Method in exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
getParameters() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Method getParameters.
getPhase() - Method in class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution: Get the phase in the sub-lifecycle.
getPhase() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get the phase to which this mojo should be bound by default.
getProperty() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get the JavaBeans property name to use to configure the mojo with this parameter.
getRequiresDependencyResolution() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get the scope of dependencies that this mojo requires to have resolved.
getRole() - Method in class org.apache.maven.tools.plugin.extractor.model.Component: Get the component role to lookup.
getSince() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get version when the mojo was added to the API.
getSince() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get version when the parameter was added.
getType() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get the java type for this parameter.

I

IMPL_BASE_PLACEHOLDER - Static variable in class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser: Default implementation path which will be replaced in AbstractScriptedMojoDescriptorExtractor#extractMojoDescriptorsFromMetadata(Map, PluginDescriptor)
isAggregator() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get whether this mojo operates as an aggregator when the reactor is run.
isInheritByDefault() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get whether this mojo's configuration should propagate down the POM inheritance chain by default.
isReadonly() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get whether this parameter can be directly edited.
isRequired() - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Get whether this parameter is required.
isRequiresDirectInvocation() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get if true, this mojo can only be directly invoked (eg.
isRequiresOnline() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get whether this mojo requires online mode to operate normally.
isRequiresProject() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get whether this mojo requires a project instance in order to execute.
isRequiresReports() - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Get whether this mojo requires a reports section in the POM.

L

LifecycleExecution - Class in org.apache.maven.tools.plugin.extractor.model: A sub-process execution of a lifecycle to satisfy the needs of a mojo.
LifecycleExecution() - Constructor for class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution

M

Mojo - Class in org.apache.maven.tools.plugin.extractor.model: Mojo descriptor definition.
Mojo() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Mojo

O

org.apache.maven.tools.plugin.extractor.model - package org.apache.maven.tools.plugin.extractor.model
org.apache.maven.tools.plugin.extractor.model.io.xpp3 - package org.apache.maven.tools.plugin.extractor.model.io.xpp3

P

Parameter - Class in org.apache.maven.tools.plugin.extractor.model: A parameter used by a mojo, and configurable from the command line or POM configuration sections.
Parameter() - Constructor for class org.apache.maven.tools.plugin.extractor.model.Parameter
parseMojoDescriptors(File) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser
PluginMetadata - Class in org.apache.maven.tools.plugin.extractor.model: Root element of a script-based mojo's plugin metadata bindings.
PluginMetadata() - Constructor for class org.apache.maven.tools.plugin.extractor.model.PluginMetadata
PluginMetadataParseException - Exception in org.apache.maven.tools.plugin.extractor.model: Exception when plugin metadata parsing occurred.
PluginMetadataParseException(File, String) - Constructor for exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
PluginMetadataParseException(File, String, Throwable) - Constructor for exception org.apache.maven.tools.plugin.extractor.model.PluginMetadataParseException
PluginMetadataParser - Class in org.apache.maven.tools.plugin.extractor.model: Parser for plugin metadata.
PluginMetadataParser() - Constructor for class org.apache.maven.tools.plugin.extractor.model.PluginMetadataParser
PluginMetadataXpp3Reader - Class in org.apache.maven.tools.plugin.extractor.model.io.xpp3: Class PluginMetadataXpp3Reader.
PluginMetadataXpp3Reader() - Constructor for class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
PluginMetadataXpp3Reader(PluginMetadataXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
PluginMetadataXpp3Reader.ContentTransformer - Interface in org.apache.maven.tools.plugin.extractor.model.io.xpp3
PluginMetadataXpp3Writer - Class in org.apache.maven.tools.plugin.extractor.model.io.xpp3: Class PluginMetadataXpp3Writer.
PluginMetadataXpp3Writer() - Constructor for class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Writer

R

read(InputStream) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader: Method read.
read(InputStream, boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader: Method read.
read(Reader) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
read(Reader, boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader
removeComponent(Component) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Method removeComponent.
removeMojo(Mojo) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata: Method removeMojo.
removeParameter(Parameter) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Method removeParameter.

S

setAddDefaultEntities(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader: Sets the state of the "add default entities" flag.
setAggregator(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set whether this mojo operates as an aggregator when the reactor is run.
setAlias(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set an alternate name for the parameter.
setCall(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set the target/method within the script to call when this mojo executes.
setComponents(List<Component>) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set list of plexus components required by this mojo.
setDefaultValue(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set an expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system.
setDeprecation(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set a deprecation message for this mojo parameter.
setDeprecation(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set a deprecation message for this mojo parameter.
setDescription(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set the description for this parameter.
setDescription(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set the description for this parameter.
setExecution(LifecycleExecution) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set information about a sub-execution of the Maven lifecycle which should be processed.
setExpression(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set the command-line reference to this parameter.
setFileComment(String) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Writer: Method setFileComment.
setGoal(String) - Method in class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution: Set a goal, not attached to a lifecycle phase, which should be executed ahead of this mojo.
setGoal(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set the name of the goal used to invoke this mojo.
setHint(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Component: Set the role-hint to lookup.
setInheritByDefault(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set whether this mojo's configuration should propagate down the POM inheritance chain by default.
setLifecycle(String) - Method in class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution: Set the name of the overlay to apply to the sub-lifecycle before executing it.
setModelEncoding(String) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata: Set the modelEncoding field.
setMojos(List<Mojo>) - Method in class org.apache.maven.tools.plugin.extractor.model.PluginMetadata: Set the list of mojos contained in the accompanying script.
setName(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set the parameter name.
setParameters(List<Parameter>) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set list of parameters used by this mojo.
setPhase(String) - Method in class org.apache.maven.tools.plugin.extractor.model.LifecycleExecution: Set the phase in the sub-lifecycle.
setPhase(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set the phase to which this mojo should be bound by default.
setProperty(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set the JavaBeans property name to use to configure the mojo with this parameter.
setReadonly(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set whether this parameter can be directly edited.
setRequired(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set whether this parameter is required.
setRequiresDependencyResolution(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set the scope of dependencies that this mojo requires to have resolved.
setRequiresDirectInvocation(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set if true, this mojo can only be directly invoked (eg.
setRequiresOnline(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set whether this mojo requires online mode to operate normally.
setRequiresProject(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set whether this mojo requires a project instance in order to execute.
setRequiresReports(boolean) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set whether this mojo requires a reports section in the POM.
setRole(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Component: Set the component role to lookup.
setSince(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Mojo: Set version when the mojo was added to the API.
setSince(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set version when the parameter was added.
setType(String) - Method in class org.apache.maven.tools.plugin.extractor.model.Parameter: Set the java type for this parameter.

T

transform(String, String) - Method in interface org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Reader.ContentTransformer: Interpolate the value read from the xpp3 document

W

write(OutputStream, PluginMetadata) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Writer: Method write.
write(Writer, PluginMetadata) - Method in class org.apache.maven.tools.plugin.extractor.model.io.xpp3.PluginMetadataXpp3Writer: Method write.

A C G I L M O P R S T W
All Classes|All Packages|Constant Field Values|Serialized Form