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  
20  package org.apache.geronimo.mavenplugins.geronimo.reporting;
21  
22  /**
23   * Provides an asbtraction to allow pluggable report handling.
24   *
25   * @version $Rev: 450613 $ $Date: 2006-09-27 15:45:46 -0700 (Wed, 27 Sep 2006) $
26   */
27  public interface Reporter
28  {
29      /**
30       * Signals the start of a reporting run.  This method should collect the required information.
31       *
32       * @param source    The source of the report; must not be null.
33       */
34      void reportBegin(Reportable source);
35  
36      /**
37       * Called when a failure has occured while executing a goal.
38       *
39       * @param cause     The cause of the error; must not be null.
40       */
41      void reportError(Throwable cause);
42  
43      /**
44       * Called after the goal has run (with or with-out errors).
45       */
46      void reportEnd();
47  }