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 * Context used to transform a pom file.
27 *
28 *
29 * @since 4.0.0
30 */
31 public interface TransformerContext {
32 /**
33 * Key to get the TransformerContext from the SessionData
34 */
35 Object KEY = TransformerContext.class;
36
37 /**
38 * Get the value of the Maven user property.
39 *
40 * @param key
41 * @return
42 */
43 String getUserProperty(String key);
44
45 /**
46 * Get the model based on the path when resolving the parent based on relativePath.
47 *
48 * @param pomFile the path to the pomFile
49 * @return the model, otherwise {@code null}
50 */
51 Model getRawModel(Path pomFile);
52
53 /**
54 * Get the model from the reactor based on the groupId and artifactId when resolving reactor dependencies.
55 *
56 * @param groupId the groupId
57 * @param artifactId the artifactId
58 * @return the model, otherwise {@code null}
59 * @throws IllegalStateException if multiple versions of the same GA are part of the reactor
60 */
61 Model getRawModel(String groupId, String artifactId);
62
63 /**
64 * Locate the POM file inside the given directory.
65 *
66 * @param path
67 * @return
68 */
69 Path locate(Path path);
70 }