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