001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.geronimo.mavenplugins.geronimo.reporting;
021    
022    /**
023     * Provides an asbtraction to allow pluggable report handling.
024     *
025     * @version $Rev: 450613 $ $Date: 2006-09-27 15:45:46 -0700 (Wed, 27 Sep 2006) $
026     */
027    public interface Reporter
028    {
029        /**
030         * Signals the start of a reporting run.  This method should collect the required information.
031         *
032         * @param source    The source of the report; must not be null.
033         */
034        void reportBegin(Reportable source);
035    
036        /**
037         * Called when a failure has occured while executing a goal.
038         *
039         * @param cause     The cause of the error; must not be null.
040         */
041        void reportError(Throwable cause);
042    
043        /**
044         * Called after the goal has run (with or with-out errors).
045         */
046        void reportEnd();
047    }