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.model.building;
20  
21  import java.nio.file.Path;
22  
23  import org.apache.maven.model.Model;
24  
25  /**
26   * The ModelSourceTransformer is a way to transform the local pom while streaming the input.
27   *
28   * The {@link #transform(Path, TransformerContext, Model)} method uses a Path on purpose, to ensure the
29   * local pom is the original source.
30   *
31   * @since 4.0.0
32   * @deprecated use {@link org.apache.maven.api.services.ModelBuilder} instead
33   */
34  @Deprecated(since = "4.0.0")
35  public interface ModelSourceTransformer {
36      /**
37       *
38       * @param pomFile the pom file, cannot be null
39       * @param context the context, cannot be null
40       * @param  model the model to transform
41       * @throws TransformerException if the transformation fails
42       */
43      void transform(Path pomFile, TransformerContext context, Model model) throws TransformerException;
44  }