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