View Javadoc
1   package org.apache.maven.plugin.surefire.log.api;
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  /**
23   * Allows providers to write console messages on the running maven process.
24   * <br>
25   * This output is associated with the entire test run and not a specific
26   * test, which means it just goes "straight" to the console "immediately".
27   * <br>
28   * This interface is used in org.apache.maven.plugin.surefire.CommonReflector and reflected
29   * via IsolatedClassLoader which can see classes from JRE only. This interface MUST use
30   * JRE types in method signatures, e.g. {@link String} or {@link Throwable}, etc.
31   */
32  public interface ConsoleLogger
33  {
34      boolean isDebugEnabled();
35  
36      void debug( String message );
37  
38      boolean isInfoEnabled();
39  
40      void info( String message );
41  
42      boolean isWarnEnabled();
43  
44      void warning( String message );
45  
46      boolean isErrorEnabled();
47  
48      /**
49       * @param message          message to log
50       */
51      void error( String message );
52  
53      /**
54       * Simply delegates to {@link #error(String) error( toString( t, message ) )}.
55       *
56       * @param message          message to log
57       * @param t                exception, message and trace to log
58       */
59      void error( String message, Throwable t );
60  
61      /**
62       * Simply delegates to method {@link #error(String, Throwable) error(null, Throwable)}.
63       *
64       * @param t                exception, message and trace to log
65       */
66      void error( Throwable t );
67  }