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.spi;
20
21 import org.apache.maven.api.annotations.Consumer;
22 import org.apache.maven.api.annotations.Experimental;
23 import org.apache.maven.api.annotations.Nonnull;
24 import org.apache.maven.api.di.Named;
25 import org.apache.maven.api.model.Model;
26
27 /**
28 * Marker interface for model transformers.
29 *
30 * @since 4.0.0
31 */
32 @Experimental
33 @Consumer
34 @Named
35 public interface ModelTransformer extends SpiService {
36
37 /**
38 * Apply a transformation on the file model.
39 *
40 * This method will be called on each file model being loaded,
41 * just before validation.
42 *
43 * @param model the input model
44 * @return the transformed model, or the input model if no transformation is needed
45 * @throws ModelTransformerException
46 */
47 @Nonnull
48 default Model transformFileModel(@Nonnull Model model) throws ModelTransformerException {
49 return model;
50 }
51
52 /**
53 * Apply a transformation on the raw models.
54 *
55 * This method will be called on each raw model being loaded,
56 * just before validation.
57 *
58 * @param model the input model
59 * @return the transformed model, or the input model if no transformation is needed
60 * @throws ModelTransformerException
61 */
62 @Nonnull
63 default Model transformRawModel(@Nonnull Model model) throws ModelTransformerException {
64 return model;
65 }
66
67 /**
68 * Apply a transformation on the effective models.
69 *
70 * This method will be called on each effective model being loaded,
71 * just before validation.
72 *
73 * @param model the input model
74 * @return the transformed model, or the input model if no transformation is needed
75 * @throws ModelTransformerException
76 */
77 @Nonnull
78 default Model transformEffectiveModel(@Nonnull Model model) throws ModelTransformerException {
79 return model;
80 }
81 }