Package org.apache.maven.model.building

Interface ModelBuildingResult

public interface ModelBuildingResult

Collects the output of the model builder.

Author:

Benjamin Bentmann

Method Summary

Modifier and Type	Method	Description
java.util.List<org.apache.maven.model.Profile>	getActiveExternalProfiles()	Gets the external profiles that were active during model building.
java.util.List<org.apache.maven.model.Profile>	getActivePomProfiles(java.lang.String modelId)	Gets the profiles from the specified model that were active during model building.
org.apache.maven.model.Model	getEffectiveModel()	Gets the assembled model.
java.util.List<java.lang.String>	getModelIds()	Gets the sequence of model identifiers that denote the lineage of models from which the effective model was constructed.
java.util.List<ModelProblem>	getProblems()	Gets the problems that were encountered during the model building.
org.apache.maven.model.Model	getRawModel()	Gets the raw model as it was read from the input model source.
org.apache.maven.model.Model	getRawModel(java.lang.String modelId)	Gets the specified raw model as it was read from a model source.

Method Detail

getModelIds

java.util.List<java.lang.String> getModelIds()

Gets the sequence of model identifiers that denote the lineage of models from which the effective model was constructed. Model identifiers have the form <groupId>:<artifactId>:<version>. The first identifier from the list denotes the model on which the model builder was originally invoked. The last identifier will always be an empty string that by definition denotes the super POM.

Returns:

The model identifiers from the lineage of models, never null.

getEffectiveModel

org.apache.maven.model.Model getEffectiveModel()

Gets the assembled model.

Returns:

The assembled model, never null.

getRawModel

org.apache.maven.model.Model getRawModel()

Gets the raw model as it was read from the input model source. Apart from basic validation, the raw model has not undergone any updates by the model builder, e.g. reflects neither inheritance nor interpolation.

Returns:

The raw model, never null.

getRawModel

org.apache.maven.model.Model getRawModel(java.lang.String modelId)

Gets the specified raw model as it was read from a model source. Apart from basic validation, a raw model has not undergone any updates by the model builder, e.g. reflects neither inheritance nor interpolation. The model identifier should be from the collection obtained by getModelIds(). As a special case, an empty string can be used as the identifier for the super POM.

Parameters:

modelId - The identifier of the desired raw model, must not be null.

Returns:

The raw model or null if the specified model id does not refer to a known model.

getActivePomProfiles

java.util.List<org.apache.maven.model.Profile> getActivePomProfiles(java.lang.String modelId)

Gets the profiles from the specified model that were active during model building. The model identifier should be from the collection obtained by getModelIds(). As a special case, an empty string can be used as the identifier for the super POM.

Parameters:

modelId - The identifier of the model whose active profiles should be retrieved, must not be null.

Returns:

The active profiles of the model or an empty list if none or null if the specified model id does not refer to a known model.

getActiveExternalProfiles

java.util.List<org.apache.maven.model.Profile> getActiveExternalProfiles()

Gets the external profiles that were active during model building. External profiles are those that were contributed by ModelBuildingRequest.getProfiles().

Returns:

The active external profiles or an empty list if none, never null.

getProblems

java.util.List<ModelProblem> getProblems()

Gets the problems that were encountered during the model building. Note that only problems of severity ModelProblem.Severity.WARNING and below are reported here. Problems with a higher severity level cause the model builder to fail with a ModelBuildingException.

Returns:

The problems that were encountered during the model building, can be empty but never null.