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