View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.api.services;
20  
21  import java.nio.file.Path;
22  
23  import org.apache.maven.api.annotations.Nonnull;
24  import org.apache.maven.api.model.Model;
25  
26  /**
27   * The ModelTransformer is a way to transform the local pom while streaming the input.
28   *
29   * The {@link #transform(ModelTransformerContext, Model, Path)} method uses a Path on purpose, to ensure the
30   * local pom is the original source.
31   *
32   * @since 4.0.0
33   */
34  public interface ModelTransformer {
35      /**
36       * @param context the context, cannot be null
37       * @param model   the model to transform
38       * @param path    the pom file, cannot be null
39       * @throws ModelTransformerException if the transformation fails
40       */
41      @Nonnull
42      Model transform(@Nonnull ModelTransformerContext context, @Nonnull Model model, @Nonnull Path path)
43              throws ModelTransformerException;
44  }