From 08cd79161b2da8124784e8d7bbf0de46609e4fc8 Mon Sep 17 00:00:00 2001
From: Simon Kitching <skitching@apache.org>
Date: Tue, 28 Feb 2006 23:57:11 +0000
Subject: [PATCH] Trivial javadoc patch to add return type info for
 isXXXEnabled methods. Thanks to Boris Unckel for patch; see bugzilla#38783.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@381838 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/commons/logging/Log.java | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/java/org/apache/commons/logging/Log.java b/src/java/org/apache/commons/logging/Log.java
index aa868e8..8eff99d 100644
--- a/src/java/org/apache/commons/logging/Log.java
+++ b/src/java/org/apache/commons/logging/Log.java
@@ -71,6 +71,8 @@ public interface Log {
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than debug. </p>
+     *
+     * @return true if debug is enabled in the underlying logger.
      */
     public boolean isDebugEnabled();
 
@@ -81,6 +83,8 @@ public interface Log {
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than error. </p>
+     *
+     * @return true if error is enabled in the underlying logger.
      */
     public boolean isErrorEnabled();
 
@@ -91,6 +95,8 @@ public interface Log {
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than fatal. </p>
+     *
+     * @return true if fatal is enabled in the underlying logger.
      */
     public boolean isFatalEnabled();
 
@@ -101,6 +107,8 @@ public interface Log {
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than info. </p>
+     *
+     * @return true if info is enabled in the underlying logger.
      */
     public boolean isInfoEnabled();
 
@@ -111,6 +119,8 @@ public interface Log {
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than trace. </p>
+     *
+     * @return true if trace is enabled in the underlying logger.
      */
     public boolean isTraceEnabled();
 
@@ -121,6 +131,8 @@ public interface Log {
      * <p> Call this method to prevent having to perform expensive operations
      * (for example, <code>String</code> concatenation)
      * when the log level is more than warn. </p>
+     *
+     * @return true if warn is enabled in the underlying logger.
      */
     public boolean isWarnEnabled();