org.apache.felix.scrplugin.Log Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.felix.scr.generator Show documentation
Provides the implementation to generate Declarative Services and Metatype Service descriptors from Java 5 Annotations and/or JavaDoc tags.
There is a newer version: 1.18.4
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.felix.scrplugin;


/**
 * This interface supplies the API for providing feedback to the user from
 * SCR descriptor generation process using whatever means is implemented. There
 * should be no big surprises here.
 */
public interface Log {

    /**
     * @return true if the debug error level is enabled
     */
    boolean isDebugEnabled();


    /**
     * Send a message to the user in the debug error level.
     *
     * @param content
     */
    void debug( String content );


    /**
     * Send a message (and accompanying exception) to the user in the debug error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param error
     */
    void debug( String content, Throwable error );


    /**
     * Send an exception to the user in the debug error level.
     * 

     * The stack trace for this exception will be output when this error level is enabled.
     *
     * @param error
     */
    void debug( Throwable error );


    /**
     * @return true if the info error level is enabled
     */
    boolean isInfoEnabled();


    /**
     * Send a message to the user in the info error level.
     *
     * @param content
     */
    void info( String content );


    /**
     * Send a message (and accompanying exception) to the user in the info error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param error
     */
    void info( String content, Throwable error );


    /**
     * Send an exception to the user in the info error level.
     * 

     * The stack trace for this exception will be output when this error level is enabled.
     *
     * @param error
     */
    void info( Throwable error );


    /**
     * @return true if the warn error level is enabled
     */
    boolean isWarnEnabled();


    /**
     * Send a message to the user in the warn error level.
     *
     * @param content
     */
    void warn( String content );

    /**
     * Send a message (and accompanying exception) to the user in the warn error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param location The location at which the error occurred
     * @param lineNumber The line number at which the error occurred
     */
    void warn( String content, String location, int lineNumber );

    /**
     * Send a message (and accompanying exception) to the user in the warn error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param location The location at which the error occurred
     * @param lineNumber The line number at which the error occurred
     * @param columnNumber The column number at which the error occurred
     */
    void warn( String content, String location, int lineNumber, int columnNumber );


    /**
     * Send a message (and accompanying exception) to the user in the warn error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param error
     */
    void warn( String content, Throwable error );


    /**
     * Send an exception to the user in the warn error level.
     * 

     * The stack trace for this exception will be output when this error level is enabled.
     *
     * @param error
     */
    void warn( Throwable error );


    /**
     * @return true if the error error level is enabled
     */
    boolean isErrorEnabled();


    /**
     * Send a message to the user in the error error level.
     *
     * @param content
     */
    void error( String content );


    /**
     * Send a message (and accompanying exception) to the user in the error error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param location The location at which the error occurred
     * @param lineNumber The line number at which the error occurred
     */
    void error( String content, String location, int lineNumber );

    /**
     * Send a message (and accompanying exception) to the user in the error error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param location The location at which the error occurred
     * @param lineNumber The line number at which the error occurred
     * @param columnNumber The column number at which the error occurred
     */
    void error( String content, String location, int lineNumber, int columnNumber );
    

    /**
     * Send a message (and accompanying exception) to the user in the error error level.
     * 

     * The error's stacktrace will be output when this error level is enabled.
     *
     * @param content
     * @param error
     */
    void error( String content, Throwable error );


    /**
     * Send an exception to the user in the error error level.
     * 

     * The stack trace for this exception will be output when this error level is enabled.
     *
     * @param error
     */
    void error( Throwable error );
}