001package org.apache.maven.model.building;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.model.Model;
023
024/**
025 * Holds data relevant for a model building event.
026 *
027 * @author Benjamin Bentmann
028 */
029public interface ModelBuildingEvent
030{
031
032    /**
033     * Gets the model being built. The precise state of this model depends on the event being fired.
034     *
035     * @return The model being built, never {@code null}.
036     */
037    Model getModel();
038
039    /**
040     * Gets the model building request being processed.
041     *
042     * @return The model building request being processed, never {@code null}.
043     */
044    ModelBuildingRequest getRequest();
045
046    /**
047     * Gets the container used to collect problems that were encountered while processing the event.
048     *
049     * @return The container used to collect problems that were encountered, never {@code null}.
050     */
051    ModelProblemCollector getProblems();
052
053}