Package org.apache.maven.api.services

Interface ModelBuilderResult

All Superinterfaces:
Result<ModelBuilderRequest>
@Experimental public interface ModelBuilderResult extends Result<ModelBuilderRequest>
Result of a project build call.
Since:
4.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.apache.maven.api.model.Profile>
    getActiveExternalProfiles()
    Gets the external profiles that were active during model building.
    List<org.apache.maven.api.model.Profile>
    getActivePomProfiles()
    Gets the profiles that were active during model building.
    List<? extends ModelBuilderResult>
    getChildren()
    Gets the children of this result.
    org.apache.maven.api.model.Model
    getEffectiveModel()
    Gets the assembled model with inheritance, interpolation and profile injection.
    org.apache.maven.api.model.Model
    getFileModel()
    Gets the file model.
    org.apache.maven.api.model.Model
    getParentModel()
    Gets the effective model of the parent POM.
    ProblemCollector<ModelProblem>
    getProblemCollector()
    Gets the problem collector that collected problems encountered during the project building.
    org.apache.maven.api.model.Model
    getRawModel()
    Gets the file model + build pom transformation, without inheritance nor interpolation.
    ModelSource
    getSource()
    Gets the source from which the model was read.
    String
    toString()
    Creates a human-readable representation of these errors.

    Methods inherited from interface org.apache.maven.api.services.Result

    getRequest

  • Method Details

    • getSource

      @Nonnull ModelSource getSource()
      Gets the source from which the model was read.
      Returns:
      The source from which the model was read, never null.

    • getFileModel

      @Nonnull org.apache.maven.api.model.Model getFileModel()
      Gets the file model.
      Returns:
      the file model, never null.

    • getRawModel

      @Nonnull org.apache.maven.api.model.Model getRawModel()
      Gets the file model + build pom transformation, without inheritance nor interpolation.
      Returns:
      The raw model, never null.

    • getParentModel

      @Nonnull org.apache.maven.api.model.Model getParentModel()
      Gets the effective model of the parent POM.
      Returns:
      the effective model of the parent POM, never null

    • getEffectiveModel

      @Nonnull org.apache.maven.api.model.Model getEffectiveModel()
      Gets the assembled model with inheritance, interpolation and profile injection.
      Returns:
      The assembled model, never null.

    • getActivePomProfiles

      @Nonnull List<org.apache.maven.api.model.Profile> getActivePomProfiles()
      Gets the profiles that were active during model building.
      Returns:
      The active profiles of the model or an empty list if the model has no active profiles.

    • getActiveExternalProfiles

      @Nonnull List<org.apache.maven.api.model.Profile> getActiveExternalProfiles()
      Gets the external profiles that were active during model building. External profiles are those that were contributed by ModelBuilderRequest.getProfiles().
      Returns:
      The active external profiles or an empty list if none, never null.

    • getProblemCollector

      @Nonnull ProblemCollector<ModelProblem> getProblemCollector()
      Gets the problem collector that collected problems encountered during the project building.
      Returns:
      the problem collector that collected problems encountered during the project building

    • getChildren

      @Nonnull List<? extends ModelBuilderResult> getChildren()
      Gets the children of this result.
      Returns:
      the children of this result, can be empty but never null

    • toString

      String toString()
      Creates a human-readable representation of these errors.
      Overrides:
      toString in class Object