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.nio.file.Path;
23
24 import org.apache.maven.model.Model;
25
26 /**
27 * Context used to transform a pom file.
28 *
29 *
30 * @author Robert Scholte
31 * @since 4.0.0
32 */
33 public interface TransformerContext
34 {
35 /**
36 * Key to get the TransformerContext from the SessionData
37 */
38 Object KEY = TransformerContext.class;
39
40 /**
41 * Get the value of the commandline argument {@code -Dkey=value}
42 * @param key
43 * @return
44 */
45 String getUserProperty( String key );
46
47 /**
48 * Get the model based on the path, will be used to resolve the parent based on relativePath
49 *
50 * @param pomFile the path to the pomFile
51 * @return the model, otherwise {@code null}
52 */
53 Model getRawModel( Path pomFile );
54
55 /**
56 * Get the model from the reactor based on the groupId and artifactId, will be used for reactor dependencies
57 *
58 * @param groupId the groupId
59 * @param artifactId the artifactId
60 * @return the model, otherwise {@code null}
61 * @throws IllegalStateException if multiple versions of the same GA are part of the reactor
62 */
63 Model getRawModel( String groupId, String artifactId );
64 }