From commits-return-696-apmail-logging-commits-archive=logging.apache.org@logging.apache.org Sat May 26 15:06:48 2012 Return-Path: X-Original-To: apmail-logging-commits-archive@minotaur.apache.org Delivered-To: apmail-logging-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id C0F7B9542 for ; Sat, 26 May 2012 15:06:48 +0000 (UTC) Received: (qmail 67949 invoked by uid 500); 26 May 2012 15:06:48 -0000 Delivered-To: apmail-logging-commits-archive@logging.apache.org Received: (qmail 67923 invoked by uid 500); 26 May 2012 15:06:48 -0000 Mailing-List: contact commits-help@logging.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@logging.apache.org Delivered-To: mailing list commits@logging.apache.org Received: (qmail 67915 invoked by uid 99); 26 May 2012 15:06:48 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 26 May 2012 15:06:48 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 26 May 2012 15:06:46 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id B7F652388860; Sat, 26 May 2012 15:06:26 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1342905 - /logging/log4j/trunk/src/main/java/org/apache/log4j/Level.java Date: Sat, 26 May 2012 15:06:26 -0000 To: commits@logging.apache.org From: ggregory@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120526150626.B7F652388860@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: ggregory Date: Sat May 26 15:06:26 2012 New Revision: 1342905 URL: http://svn.apache.org/viewvc?rev=1342905&view=rev Log: Fix Javadoc to use common formatting with a * at the start of each line. Fix other formating, no more 'static', 'public', 'type' on separate lines. Use { } for all blocks. Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/Level.java Modified: logging/log4j/trunk/src/main/java/org/apache/log4j/Level.java URL: http://svn.apache.org/viewvc/logging/log4j/trunk/src/main/java/org/apache/log4j/Level.java?rev=1342905&r1=1342904&r2=1342905&view=diff ============================================================================== --- logging/log4j/trunk/src/main/java/org/apache/log4j/Level.java (original) +++ logging/log4j/trunk/src/main/java/org/apache/log4j/Level.java Sat May 26 15:06:26 2012 @@ -37,161 +37,177 @@ import java.io.Serializable; */ public class Level extends Priority implements Serializable { - /** - * TRACE level integer value. - * @since 1.2.12 - */ - public static final int TRACE_INT = 5000; - - /** - The OFF has the highest possible rank and is - intended to turn off logging. */ - final static public Level OFF = new Level(OFF_INT, "OFF", 0); - - /** - The FATAL level designates very severe error - events that will presumably lead the application to abort. - */ - final static public Level FATAL = new Level(FATAL_INT, "FATAL", 0); - - /** - The ERROR level designates error events that - might still allow the application to continue running. */ - final static public Level ERROR = new Level(ERROR_INT, "ERROR", 3); - - /** - The WARN level designates potentially harmful situations. - */ - final static public Level WARN = new Level(WARN_INT, "WARN", 4); - - /** - The INFO level designates informational messages - that highlight the progress of the application at coarse-grained - level. */ - final static public Level INFO = new Level(INFO_INT, "INFO", 6); - - /** - The DEBUG Level designates fine-grained - informational events that are most useful to debug an - application. */ - final static public Level DEBUG = new Level(DEBUG_INT, "DEBUG", 7); - - /** - * The TRACE Level designates finer-grained - * informational events than the DEBUGALL has the lowest possible rank and is intended to - turn on all logging. */ - final static public Level ALL = new Level(ALL_INT, "ALL", 7); - - /** - * Serialization version id. - */ - static final long serialVersionUID = 3491141966387921974L; - - /** - Instantiate a Level object. - */ - protected - Level(int level, String levelStr, int syslogEquivalent) { - super(level, levelStr, syslogEquivalent); - } - - - /** - Convert the string passed as argument to a level. If the - conversion fails, then this method returns {@link #DEBUG}. - */ - public - static - Level toLevel(String sArg) { - return toLevel(sArg, Level.DEBUG); - } - - /** - Convert an integer passed as argument to a level. If the - conversion fails, then this method returns {@link #DEBUG}. - - */ - public - static - Level toLevel(int val) { - return toLevel(val, Level.DEBUG); - } - - /** - Convert an integer passed as argument to a level. If the - conversion fails, then this method returns the specified default. - */ - public - static - Level toLevel(int val, Level defaultLevel) { - switch(val) { - case ALL_INT: return ALL; - case DEBUG_INT: return Level.DEBUG; - case INFO_INT: return Level.INFO; - case WARN_INT: return Level.WARN; - case ERROR_INT: return Level.ERROR; - case FATAL_INT: return Level.FATAL; - case OFF_INT: return OFF; - case TRACE_INT: return Level.TRACE; - default: return defaultLevel; - } - } - - /** - Convert the string passed as argument to a level. If the - conversion fails, then this method returns the value of - defaultLevel. - */ - public - static - Level toLevel(String sArg, Level defaultLevel) { - if(sArg == null) - return defaultLevel; - - String s = sArg.toUpperCase(); - - if(s.equals("ALL")) return Level.ALL; - if(s.equals("DEBUG")) return Level.DEBUG; - if(s.equals("INFO")) return Level.INFO; - if(s.equals("WARN")) return Level.WARN; - if(s.equals("ERROR")) return Level.ERROR; - if(s.equals("FATAL")) return Level.FATAL; - if(s.equals("OFF")) return Level.OFF; - if(s.equals("TRACE")) return Level.TRACE; - // - // For Turkish i problem, see bug 40937 - // - if(s.equals("\u0130NFO")) return Level.INFO; - return defaultLevel; - } + /** + * TRACE level integer value. + * + * @since 1.2.12 + */ + public static final int TRACE_INT = 5000; + + /** + * The OFF has the highest possible rank and is intended to turn off logging. + */ + final static public Level OFF = new Level(OFF_INT, "OFF", 0); + + /** + * The FATAL level designates very severe error events that will presumably lead the application to abort. + */ + final static public Level FATAL = new Level(FATAL_INT, "FATAL", 0); + + /** + * The ERROR level designates error events that might still allow the application to continue running. + */ + final static public Level ERROR = new Level(ERROR_INT, "ERROR", 3); + + /** + * The WARN level designates potentially harmful situations. + */ + final static public Level WARN = new Level(WARN_INT, "WARN", 4); + + /** + * The INFO level designates informational messages that highlight the progress of the application at coarse-grained level. + */ + final static public Level INFO = new Level(INFO_INT, "INFO", 6); + + /** + * The DEBUG Level designates fine-grained informational events that are most useful to debug an application. + */ + final static public Level DEBUG = new Level(DEBUG_INT, "DEBUG", 7); + + /** + * The TRACE Level designates finer-grained informational events than the DEBUGALL has the lowest possible rank and is intended to turn on all logging. + */ + final static public Level ALL = new Level(ALL_INT, "ALL", 7); + + /** + * Serialization version id. + */ + static final long serialVersionUID = 3491141966387921974L; + + /** + * Instantiate a Level object. + */ + protected Level(int level, String levelStr, int syslogEquivalent) { + super(level, levelStr, syslogEquivalent); + } + + /** + * Convert the string passed as argument to a level. If the conversion fails, then this method returns {@link #DEBUG}. + */ + public static Level toLevel(String sArg) { + return toLevel(sArg, Level.DEBUG); + } + + /** + * Convert an integer passed as argument to a level. If the conversion fails, then this method returns {@link #DEBUG}. + */ + public static Level toLevel(int val) { + return toLevel(val, Level.DEBUG); + } + + /** + * Convert an integer passed as argument to a level. If the conversion fails, then this method returns the specified default. + */ + public static Level toLevel(int val, Level defaultLevel) { + switch (val) { + case ALL_INT: + return ALL; + case DEBUG_INT: + return Level.DEBUG; + case INFO_INT: + return Level.INFO; + case WARN_INT: + return Level.WARN; + case ERROR_INT: + return Level.ERROR; + case FATAL_INT: + return Level.FATAL; + case OFF_INT: + return OFF; + case TRACE_INT: + return Level.TRACE; + default: + return defaultLevel; + } + } + + /** + * Convert the string passed as argument to a level. If the conversion fails, then this method returns the value of + * defaultLevel. + */ + public static Level toLevel(String sArg, Level defaultLevel) { + if (sArg == null) { + return defaultLevel; + } + String s = sArg.toUpperCase(); + + if (s.equals("ALL")) { + return Level.ALL; + } + if (s.equals("DEBUG")) { + return Level.DEBUG; + } + if (s.equals("INFO")) { + return Level.INFO; + } + if (s.equals("WARN")) { + return Level.WARN; + } + if (s.equals("ERROR")) { + return Level.ERROR; + } + if (s.equals("FATAL")) { + return Level.FATAL; + } + if (s.equals("OFF")) { + return Level.OFF; + } + if (s.equals("TRACE")) { + return Level.TRACE; + } + // + // For Turkish i problem, see bug 40937 + // + if (s.equals("\u0130NFO")) { + return Level.INFO; + } + return defaultLevel; + } /** * Custom deserialization of Level. - * @param s serialization stream. - * @throws IOException if IO exception. - * @throws ClassNotFoundException if class not found. + * + * @param s + * serialization stream. + * @throws IOException + * if IO exception. + * @throws ClassNotFoundException + * if class not found. */ private void readObject(final ObjectInputStream s) throws IOException, ClassNotFoundException { - s.defaultReadObject(); - level = s.readInt(); - syslogEquivalent = s.readInt(); - levelStr = s.readUTF(); - if (levelStr == null) { - levelStr = ""; - } + s.defaultReadObject(); + level = s.readInt(); + syslogEquivalent = s.readInt(); + levelStr = s.readUTF(); + if (levelStr == null) { + levelStr = ""; + } } /** * Serialize level. - * @param s serialization stream. - * @throws IOException if exception during serialization. + * + * @param s + * serialization stream. + * @throws IOException + * if exception during serialization. */ private void writeObject(final ObjectOutputStream s) throws IOException { s.defaultWriteObject(); @@ -201,20 +217,21 @@ public class Level extends Priority impl } /** - * Resolved deserialized level to one of the stock instances. - * May be overriden in classes derived from Level. + * Resolved deserialized level to one of the stock instances. May be overriden in classes derived from Level. + * * @return resolved object. - * @throws ObjectStreamException if exception during resolution. + * @throws ObjectStreamException + * if exception during resolution. */ private Object readResolve() throws ObjectStreamException { // - // if the deserizalized object is exactly an instance of Level + // if the deserizalized object is exactly an instance of Level // if (getClass() == Level.class) { return toLevel(level); } // - // extension of Level can't substitute stock item + // extension of Level can't substitute stock item // return this; }