org.apache.maven.doxia.logging.Log Maven / Gradle / Ivy
package org.apache.maven.doxia.logging;
/*
* 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.
*/
/**
* This interface supplies the API for providing feedback to the user from
* a Parser or Sink, using standard Doxia channels.
*
* There should be no big surprises here, although you may notice that the methods accept
* java.lang.CharSequence rather than java.lang.String. This is provided mainly as a
* convenience, to enable developers to pass things like java.lang.StringBuilder directly into the logger,
* rather than formatting first by calling toString().
*
* Based on org.apache.maven.plugin.logging.Log.
*
* @author jdcasey
* @author ltheussl
* @version $Id: Log.java 1438269 2013-01-24 23:47:50Z olamy $
* @since 1.1
*/
public interface Log
{
/** Typecode for debugging messages. */
int LEVEL_DEBUG = 0;
/** Typecode for informational messages. */
int LEVEL_INFO = 1;
/** Typecode for warning messages. */
int LEVEL_WARN = 2;
/** Typecode for error messages. */
int LEVEL_ERROR = 3;
/** Typecode for fatal error messages. */
int LEVEL_FATAL = 4;
/** Typecode for disabled log levels. */
int LEVEL_DISABLED = 5;
/**
* Set the current log level.
*
* @param level the log level to set.
*/
void setLogLevel( int level );
/**
* isDebugEnabled.
*
* @return true if the debug error level is enabled.
*/
boolean isDebugEnabled();
/**
* Send a message to the user in the debug error level.
*
* @param content the message to log.
*/
void debug( CharSequence 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 the message to log.
* @param error the error to log.
*/
void debug( CharSequence 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 the error to log.
*/
void debug( Throwable error );
/**
* isInfoEnabled.
*
* @return true if the info error level is enabled.
*/
boolean isInfoEnabled();
/**
* Send a message to the user in the info error level.
*
* @param content the message to log.
*/
void info( CharSequence 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 the message to log.
* @param error the error to log.
*/
void info( CharSequence 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 the error to log.
*/
void info( Throwable error );
/**
* isWarnEnabled.
*
* @return true if the warn error level is enabled.
*/
boolean isWarnEnabled();
/**
* Send a message to the user in the warn error level.
*
* @param content the message to log.
*/
void warn( CharSequence 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 the message to log.
* @param error the error to log.
*/
void warn( CharSequence 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 the error to log.
*/
void warn( Throwable error );
/**
* isErrorEnabled.
*
* @return true if the error error level is enabled.
*/
boolean isErrorEnabled();
/**
* Send a message to the user in the error error level.
*
* @param content the message to log.
*/
void error( CharSequence 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 the message to log.
* @param error the error to log.
*/
void error( CharSequence 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 the error to log.
*/
void error( Throwable error );
}