com.amazonaws.log.InternalLogApi Maven / Gradle / Ivy
Show all versions of aws-java-sdk-core Show documentation
/*
* 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 com.amazonaws.log;
/**
* An SDK internal logging API, not intended for general use. This logging API
* allows a minimal set of signer related classes to make use of logging without
* direct dependency on any third party library.
*
* @see InternalLogFactory
*/
public interface InternalLogApi {
/**
* Logs a message with debug log level.
*
* @param message
* log this message
*/
void debug(Object message);
/**
* Logs an error with debug log level.
*
* @param message
* log this message
* @param t
* log this cause
*/
void debug(Object message, Throwable t);
/**
* Logs a message with error log level.
*
* @param message
* log this message
*/
void error(Object message);
/**
* Logs an error with error log level.
*
* @param message
* log this message
* @param t
* log this cause
*/
void error(Object message, Throwable t);
/**
* Logs a message with fatal log level.
*
* @param message
* log this message
*/
void fatal(Object message);
/**
* Logs an error with fatal log level.
*
* @param message
* log this message
* @param t
* log this cause
*/
void fatal(Object message, Throwable t);
/**
* Logs a message with info log level.
*
* @param message
* log this message
*/
void info(Object message);
/**
* Logs an error with info log level.
*
* @param message
* log this message
* @param t
* log this cause
*/
void info(Object message, Throwable t);
/**
* Is debug logging currently enabled?
*
* Call this method to prevent having to perform expensive operations (for
* example, String concatenation) when the log level is more
* than debug.
*
* @return true if debug is enabled in the underlying logger.
*/
boolean isDebugEnabled();
/**
* Is error logging currently enabled?
*
* Call this method to prevent having to perform expensive operations (for
* example, String concatenation) when the log level is more
* than error.
*
* @return true if error is enabled in the underlying logger.
*/
boolean isErrorEnabled();
/**
* Is fatal logging currently enabled?
*
* Call this method to prevent having to perform expensive operations (for
* example, String concatenation) when the log level is more
* than fatal.
*
* @return true if fatal is enabled in the underlying logger.
*/
boolean isFatalEnabled();
/**
* Is info logging currently enabled?
*
* Call this method to prevent having to perform expensive operations (for
* example, String concatenation) when the log level is more
* than info.
*
* @return true if info is enabled in the underlying logger.
*/
boolean isInfoEnabled();
/**
* Is trace logging currently enabled?
*
* Call this method to prevent having to perform expensive operations (for
* example, String concatenation) when the log level is more
* than trace.
*
* @return true if trace is enabled in the underlying logger.
*/
boolean isTraceEnabled();
/**
* Is warn logging currently enabled?
*
* Call this method to prevent having to perform expensive operations (for
* example, String concatenation) when the log level is more
* than warn.
*
* @return true if warn is enabled in the underlying logger.
*/
boolean isWarnEnabled();
/**
* Logs a message with trace log level.
*
* @param message
* log this message
*/
void trace(Object message);
/**
* Logs an error with trace log level.
*
* @param message
* log this message
* @param t
* log this cause
*/
void trace(Object message, Throwable t);
/**
* Logs a message with warn log level.
*
* @param message
* log this message
*/
void warn(Object message);
/**
* Logs an error with warn log level.
*
* @param message
* log this message
* @param t
* log this cause
*/
void warn(Object message, Throwable t);
}