Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- alignToBaseDirectory(String, Path) - Method in interface org.apache.maven.api.services.model.PathTranslator
-
Resolves the specified path against the given base directory.
- alignToBaseDirectory(Model, Path, ModelBuilderRequest) - Method in interface org.apache.maven.api.services.model.ModelPathTranslator
-
Resolves the well-known paths of the specified model against the given base directory.
- artifactId() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
artifactIdrecord component. - assembleModelInheritance(Model, Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.InheritanceAssembler
-
Merges values from the specified parent model into the given child model.
C
- classifier() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
classifierrecord component. - contribute(Map) - Method in interface org.apache.maven.api.spi.PropertyContributor
-
Invoked just before session is created with a mutable map that carries collected user properties so far.
- contribute(ProtoSession) - Method in interface org.apache.maven.api.spi.PropertyContributor
-
Invoked just before session is created with proto session instance.
D
- DependencyManagementImporter - Interface in org.apache.maven.api.services.model
-
Handles the import of dependency management from other models into the target model.
- DependencyManagementInjector - Interface in org.apache.maven.api.services.model
-
Handles injection of dependency management into the model.
E
- equals(Object) - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Indicates whether some other object is "equal to" this one.
- exists(String, boolean) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Checks if a file or directory matching the given glob pattern exists at the specified path.
- expandPluginConfiguration(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.PluginConfigurationExpander
-
Merges values from general build plugin configuration into the individual plugin executions of the given model.
- ExtensibleEnumProvider<T> - Interface in org.apache.maven.api.spi
-
An SPI interface to extend Maven with new enum values for extensible enumerations.
F
- findMandatoryRoot(Path) - Method in interface org.apache.maven.api.services.model.RootLocator
- findRoot(Path) - Method in interface org.apache.maven.api.services.model.RootLocator
G
- getActiveProfiles(Collection, ProfileActivationContext, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ProfileSelector
-
Determines the profiles which are active in the specified activation context.
- getArtifactId() - Method in exception class org.apache.maven.api.services.model.ModelResolverException
-
Gets the artifact id of the unresolvable model.
- getColumnNumber() - Method in exception class org.apache.maven.api.spi.ModelParserException
- getGroupId() - Method in exception class org.apache.maven.api.services.model.ModelResolverException
-
Gets the group id of the unresolvable model.
- getLineNumber() - Method in exception class org.apache.maven.api.spi.ModelParserException
- getModelArtifactId() - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the artifactId from the current model.
- getModelBaseDirectory() - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the base directory of the current model.
- getModelPackaging() - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the packaging type from the current model.
- getModelProperty(String) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the model property to use for interpolation and profile activation.
- getModelRootDirectory() - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the root directory of the current model.
- getNoRootMessage() - Method in interface org.apache.maven.api.services.model.RootLocator
- getRequest() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
- getSession() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
- getSystemProperty(String) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the system property to use for interpolation and profile activation.
- getTrace() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
- getUserProperty(String) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Gets the user property to use for interpolation and profile activation.
- getVersion() - Method in exception class org.apache.maven.api.services.model.ModelResolverException
-
Gets the version of the unresolvable model.
- groupId() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
groupIdrecord component.
H
- hashCode() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Returns a hash code value for this object.
I
- importManagement(Model, List, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.DependencyManagementImporter
-
Imports the specified dependency management sections into the given target model.
- InheritanceAssembler - Interface in org.apache.maven.api.services.model
-
Handles inheritance of model values.
- injectDefaultValues(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ModelNormalizer
-
Sets default values in the specified model that for technical reasons cannot be set directly in the Modello definition.
- injectLifecycleBindings(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.LifecycleBindingsInjector
-
Injects plugin executions induced by lifecycle bindings into the specified model.
- injectManagement(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.DependencyManagementInjector
-
Merges default values from the dependency management section of the given model into itself.
- injectManagement(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.PluginManagementInjector
-
Merges default values from the plugin management section of the given model into itself.
- injectProfile(Model, Profile, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ProfileInjector
-
Merges values from the specified profile into the given model.
- injectProfiles(Model, List, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ProfileInjector
-
Merges values from the specified profile into the given model.
- interpolateModel(Model, Path, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ModelInterpolator
-
Interpolates expressions in the specified model.
- interpolatePath(String) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Interpolates the given path string using the current context's properties.
- isActive(Profile, ProfileActivationContext, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ProfileActivator
-
Determines whether the specified profile is active in the given activator context.
- isProfileActive(String) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Checks if the specified profile has been explicitly activated.
- isProfileInactive(String) - Method in interface org.apache.maven.api.services.model.ProfileActivationContext
-
Checks if the specified profile has been explicitly deactivated.
- isRootDirectory(Path) - Method in interface org.apache.maven.api.services.model.RootDetector
- isSnapshot(String) - Method in interface org.apache.maven.api.services.model.ModelVersionParser
-
Checks whether a given artifact version is considered a
SNAPSHOTor not.
L
- LanguageProvider - Interface in org.apache.maven.api.spi
-
Service provider interface for registering custom
Languageimplementations. - LifecycleBindingsInjector - Interface in org.apache.maven.api.services.model
-
Handles injection of plugin executions induced by the lifecycle bindings for a packaging.
- LifecycleProvider - Interface in org.apache.maven.api.spi
-
Service provider interface for registering custom
Lifecycleimplementations. - locate(Path) - Method in interface org.apache.maven.api.spi.ModelParser
-
Locates the pom in the given directory.
- locateAndParse(Path, Map) - Method in interface org.apache.maven.api.spi.ModelParser
-
Locate and parse the model in the specified directory.
- locateExistingPom(Path) - Method in interface org.apache.maven.api.services.model.ModelProcessor
-
Returns the file containing the pom to be parsed or null if a pom can not be found at the given file or in the given directory.
M
- mergeDuplicates(Model, ModelBuilderRequest, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ModelNormalizer
-
Merges duplicate elements like multiple declarations of the same build plugin in the specified model.
- ModelInterpolator - Interface in org.apache.maven.api.services.model
-
Replaces expressions of the form
${token}with their effective values. - ModelNormalizer - Interface in org.apache.maven.api.services.model
-
Handles normalization of a model.
- ModelParser - Interface in org.apache.maven.api.spi
-
The
ModelParserinterface is used to locate and readModels from the file system. - ModelParserException - Exception Class in org.apache.maven.api.spi
- ModelParserException() - Constructor for exception class org.apache.maven.api.spi.ModelParserException
- ModelParserException(String) - Constructor for exception class org.apache.maven.api.spi.ModelParserException
- ModelParserException(String, int, int, Throwable) - Constructor for exception class org.apache.maven.api.spi.ModelParserException
- ModelParserException(String, Throwable) - Constructor for exception class org.apache.maven.api.spi.ModelParserException
- ModelParserException(Throwable) - Constructor for exception class org.apache.maven.api.spi.ModelParserException
- ModelPathTranslator - Interface in org.apache.maven.api.services.model
-
Resolves relative paths of a model against a specific base directory.
- ModelProcessor - Interface in org.apache.maven.api.services.model
-
Locates and reads POM files from the filesystem.
- ModelResolver - Interface in org.apache.maven.api.services.model
-
Resolves a POM from its coordinates.
- ModelResolver.ModelResolverRequest - Record Class in org.apache.maven.api.services.model
- ModelResolver.ModelResolverResult - Record Class in org.apache.maven.api.services.model
- ModelResolverException - Exception Class in org.apache.maven.api.services.model
-
Signals an error when resolving the path to an external model.
- ModelResolverException(String, String, String, String) - Constructor for exception class org.apache.maven.api.services.model.ModelResolverException
-
Creates a new exception with specified detail message.
- ModelResolverException(String, String, String, String, Throwable) - Constructor for exception class org.apache.maven.api.services.model.ModelResolverException
-
Creates a new exception with specified detail message and cause.
- ModelResolverException(Throwable, String, String, String) - Constructor for exception class org.apache.maven.api.services.model.ModelResolverException
-
Creates a new exception with specified cause
- ModelResolverRequest(Session, RequestTrace, List, String, String, String, String) - Constructor for record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Creates an instance of a
ModelResolverRequestrecord class. - ModelResolverResult(ModelResolver.ModelResolverRequest, ModelSource, String) - Constructor for record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Creates an instance of a
ModelResolverResultrecord class. - ModelTransformer - Interface in org.apache.maven.api.spi
-
Interface for model transformers that can modify Maven project models at different stages of processing.
- ModelTransformerException - Exception Class in org.apache.maven.api.spi
- ModelTransformerException() - Constructor for exception class org.apache.maven.api.spi.ModelTransformerException
- ModelTransformerException(String) - Constructor for exception class org.apache.maven.api.spi.ModelTransformerException
- ModelTransformerException(String, Throwable) - Constructor for exception class org.apache.maven.api.spi.ModelTransformerException
- ModelTransformerException(Throwable) - Constructor for exception class org.apache.maven.api.spi.ModelTransformerException
- ModelUrlNormalizer - Interface in org.apache.maven.api.services.model
-
Normalizes URLs to remove the ugly parent references "../" that got potentially inserted by URL adjustment during model inheritance.
- ModelValidator - Interface in org.apache.maven.api.services.model
-
Checks the model for missing or invalid values.
- ModelVersionParser - Interface in org.apache.maven.api.services.model
-
Model builder specific version parser.
N
- normalize(String) - Method in interface org.apache.maven.api.services.model.UrlNormalizer
-
Normalizes the specified URL.
- normalize(Model, ModelBuilderRequest) - Method in interface org.apache.maven.api.services.model.ModelUrlNormalizer
-
Normalizes the well-known URLs of the specified model.
O
- org.apache.maven.api.services.model - package org.apache.maven.api.services.model
- org.apache.maven.api.spi - package org.apache.maven.api.spi
-
Defines the Service Provider Interface (SPI) for Maven extensions, allowing third-party implementations to extend and customize Maven's core functionality through a stable, versioned API.
P
- PackagingProvider - Interface in org.apache.maven.api.spi
-
Service provider interface for registering custom
Packagingimplementations. - parse(Source, Map) - Method in interface org.apache.maven.api.spi.ModelParser
-
Parse the model obtained previously by a previous call to
ModelParser.locate(Path). - parseVersion(String) - Method in interface org.apache.maven.api.services.model.ModelVersionParser
-
Parses the specified version string, for example "1.0".
- parseVersionConstraint(String) - Method in interface org.apache.maven.api.services.model.ModelVersionParser
-
Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".
- parseVersionRange(String) - Method in interface org.apache.maven.api.services.model.ModelVersionParser
-
Parses the specified version range specification, for example "[1.0,2.0)".
- PathScopeProvider - Interface in org.apache.maven.api.spi
-
Service provider interface for registering custom
PathScopeimplementations. - PathTranslator - Interface in org.apache.maven.api.services.model
-
Resolves relative paths against a specific base directory.
- PluginConfigurationExpander - Interface in org.apache.maven.api.services.model
-
Handles expansion of general build plugin configuration into individual executions.
- PluginManagementInjector - Interface in org.apache.maven.api.services.model
-
Handles injection of plugin management into the model.
- presentInConfig(Profile, ProfileActivationContext, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ProfileActivator
-
Determines whether specified activation method is present in configuration or not.
- ProfileActivationContext - Interface in org.apache.maven.api.services.model
-
Describes the environmental context used to determine the activation status of profiles.
- ProfileActivator - Interface in org.apache.maven.api.services.model
-
Determines whether a profile should be activated.
- ProfileInjector - Interface in org.apache.maven.api.services.model
-
Handles profile injection into the model.
- ProfileSelector - Interface in org.apache.maven.api.services.model
-
Calculates the active profiles among a given collection of profiles.
- ProjectScopeProvider - Interface in org.apache.maven.api.spi
-
Service provider interface for registering custom
ProjectScopeimplementations. - PropertyContributor - Interface in org.apache.maven.api.spi
-
Component able to contribute to Maven session user properties.
- provides() - Method in interface org.apache.maven.api.spi.ExtensibleEnumProvider
-
Provides new values for the extensible enum.
R
- read(XmlReaderRequest) - Method in interface org.apache.maven.api.services.model.ModelProcessor
-
Reads the model from the specified byte stream.
- repositories() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
repositoriesrecord component. - request() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Returns the value of the
requestrecord component. - resolveModel(ModelResolver.ModelResolverRequest) - Method in interface org.apache.maven.api.services.model.ModelResolver
- resolveModel(Session, List, Dependency, AtomicReference) - Method in interface org.apache.maven.api.services.model.ModelResolver
-
Tries to resolve the POM for the specified dependency coordinates possibly updating
dependency. - resolveModel(Session, List, Parent, AtomicReference) - Method in interface org.apache.maven.api.services.model.ModelResolver
-
Tries to resolve the POM for the specified parent coordinates possibly updating
parent. - RootDetector - Interface in org.apache.maven.api.services.model
-
Detects whether a given directory is a root directory.
- RootLocator - Interface in org.apache.maven.api.services.model
-
Locates the root directory for a given project.
S
- session() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
sessionrecord component. - source() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Returns the value of the
sourcerecord component. - SpiService - Interface in org.apache.maven.api.spi
-
Marker interface to indicate services that can be provided by plugins and extensions.
- STRICT - Static variable in interface org.apache.maven.api.spi.ModelParser
-
Option that can be specified in the options map.
T
- toString() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns a string representation of this record class.
- toString() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Returns a string representation of this record class.
- trace() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
tracerecord component. - transformEffectiveModel(Model) - Method in interface org.apache.maven.api.spi.ModelTransformer
-
Apply a transformation on the effective models.
- transformFileModel(Model) - Method in interface org.apache.maven.api.spi.ModelTransformer
-
Apply a transformation on the file model.
- transformRawModel(Model) - Method in interface org.apache.maven.api.spi.ModelTransformer
-
Apply a transformation on the raw models.
- TypeProvider - Interface in org.apache.maven.api.spi
-
Service provider interface for registering custom
Typeimplementations.
U
- UNABLE_TO_FIND_ROOT_PROJECT_MESSAGE - Static variable in interface org.apache.maven.api.services.model.RootLocator
- UrlNormalizer - Interface in org.apache.maven.api.services.model
-
Simplifies URLs by removing parent directory references ("/../") and collapsing path segments.
V
- validateEffectiveModel(Session, Model, int, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ModelValidator
-
Checks the specified (effective) model for missing or invalid values.
- validateFileModel(Session, Model, int, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ModelValidator
-
Checks the specified file model for missing or invalid values.
- validateRawModel(Session, Model, int, ModelProblemCollector) - Method in interface org.apache.maven.api.services.model.ModelValidator
-
Checks the specified (raw) model for missing or invalid values.
- VALIDATION_LEVEL_MAVEN_2_0 - Static variable in interface org.apache.maven.api.services.model.ModelValidator
-
Denotes validation as performed by Maven 2.0.
- VALIDATION_LEVEL_MAVEN_3_0 - Static variable in interface org.apache.maven.api.services.model.ModelValidator
-
Denotes validation as performed by Maven 3.0.
- VALIDATION_LEVEL_MAVEN_3_1 - Static variable in interface org.apache.maven.api.services.model.ModelValidator
-
Denotes validation as performed by Maven 3.1.
- VALIDATION_LEVEL_MAVEN_4_0 - Static variable in interface org.apache.maven.api.services.model.ModelValidator
-
Denotes validation as performed by Maven 4.0.
- VALIDATION_LEVEL_MINIMAL - Static variable in interface org.apache.maven.api.services.model.ModelValidator
-
Denotes minimal validation of POMs.
- VALIDATION_LEVEL_STRICT - Static variable in interface org.apache.maven.api.services.model.ModelValidator
-
Denotes strict validation as recommended by the current Maven version.
- version() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverRequest
-
Returns the value of the
versionrecord component. - version() - Method in record class org.apache.maven.api.services.model.ModelResolver.ModelResolverResult
-
Returns the value of the
versionrecord component.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form