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.services.model;
20
21 import java.util.function.Consumer;
22
23 import org.apache.maven.api.model.Model;
24 import org.apache.maven.api.services.ModelBuilderRequest;
25 import org.apache.maven.api.services.ModelProblemCollector;
26
27 /**
28 * Holds data relevant for a model building event.
29 *
30 */
31 public interface ModelBuildingEvent {
32
33 /**
34 * Gets the model being built. The precise state of this model depends on the event being fired.
35 *
36 * @return The model being built, never {@code null}.
37 */
38 Model model();
39
40 Consumer<Model> update();
41
42 /**
43 * Gets the model building request being processed.
44 *
45 * @return The model building request being processed, never {@code null}.
46 */
47 ModelBuilderRequest request();
48
49 /**
50 * Gets the container used to collect problems that were encountered while processing the event.
51 *
52 * @return The container used to collect problems that were encountered, never {@code null}.
53 */
54 ModelProblemCollector problems();
55 }