Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
I am learning GoF Java Design Patterns and I want to see some real life examples of them. Can you guys point to some good usage of these Design Patterns.(preferably in Java's core libraries). Thank you
At the moment a default entry looks something like this: Oct 12, 2008 9:45:18 AM myClassInfoHere INFO: MyLogMessageHere How do I get it to do this? Oct 12, 2008 9:45:18 AM myClassInfoHere - INFO: MyLogMessageHere Clarification I'm using java.util.logging
How does The JDK's Logger compare to Apache log4j? Which one is better for new projects that target Java 6? How do they compare in terms of flexibility and configurability?
Is there a Logger that will easily log my stacktrace (what I get with ex.printStackTrace())? I've searched the log4j docs and found nothing about logging the stacktrace. I can do this myself with StringWriter sw = new StringWriter(); ex.printStackTrace(new PrintWriter(sw)); String stacktrace = sw.toString(); logger.error(stacktrace); but I don't want to duplicate this code all over the plac...
I've seen at least three ways of acquiring dependencies in a Java object without coupling the object to the creation of the dependency; Dependency Injection - some framework injects a required object into another object based on an external configuration, example: Spring managed beans Dependency Lookup - a class looks up a required dependency in some kind of directory service, example: JNDI l...
I have some Java code that I'd like to instrument with log messages for debugging purposes. The final (compiled) production code, however, should not contain any logging as it would slow down the execution time. Is there any way in Java to disable a logger at compile time? I am not afraid of the footprint a check inside the log method of a run-time enabled/disabled logger would add. if (loggi...
I'm using the PMD plugin for eclipse and it gives me an error when using System.out.println() with the explanation: System.(out|err).print is used, consider using a logger. My question is - What is a Logger? How is it used to print to the screen? Why is it better? Thanks.
I'm developing a Java application that uses java.util.logging for its logging needs. This application uses a multitude of external libraries (JDBC, JMS clients, JSR-160 implementation, etc), some of which also use java.util.logging. I want to set the log level for my Loggers to ALL when I specify a flag on the command line, but so far I have only found ways to set the level for all loggers, no...
I generate 2 instances in this way: gameManager manager1 = new CTManager(owner,players1,"en"); manager1.start(); gameManager manager2 = new CTManager(owner,players2,"en"); manager2.start(); The start() method of the gameManager looks like that: void start() { game.start(); } When I create the game instance I create a loger: log = Logger.getLogger("TestLog"); (log is a ...
we have a habit in our company that when a bug is reported we do following steps: Write a unit test that fails clearly showing the bug exists Fix the bug Re-run the test to prove the bug has been fixed Commit the fix and the test to avoid regressions in the future Now I came across a piece of legacy code with very easy bug. Situation looks like follows: public final class SomeClass { ....
I am creating a logger in java by executing the following code: private static final String logFile = "." + File.separator + "Log Files" + File.separator + "Log_" + Long.toString(System.currentTimeMillis()); private static Logger logger = Logger.getLogger("JCS_Logger"); static { try { logger.addHandler(new FileHandler(logFile )); } catch (Exception e) { Sys...
I got a quite simple problem but cant find a solution for it. I have a logger with a file handler added, but it still spams to hell out of my console. How could I get the logger to solely route all output to a file, with NO console outputs? Thanks a lot, cru
I am using eclipse and java sdk of app-engine. I found the link for same question here and on stackoverflow here. But both are for python. Is there a way to do it in eclipse?
I am considering using SLF4j to integrate multiple logging frameworks. The java.util.logging.Logger class has a nice method called setLevel(Level newLevel). It enables logging configuration at a class level, which helps creating readable and lean traces. I could not find the equivalent in the SLF4J framework. Is there any? The SLF4J Logger interface does not offer such a method. I have seen ...
I have this 3rd party library that has: slf4j-api-1.5.5.jar slf4j-jdk14-1.5.5.jar jcl-over-slf4j-1.5.5.jar I want to write some tests against this library and see its log output, and I don't want to add any more logging libraries (no log4j or anything else). I understand that SLF4J and Common Logging are both logging abstractions so I probably need to write my own simple concrete logger (...
I have a class in which I see the following things: this.logger.severe(""); this.logger.warning(""); this.logger.info(""); I do not understand several things: How can we use a method that was not defined earlier? I mean, there are no "logger" methods defined in the class. I thought that these methods could be defined because the considered class is an extension of another class in which th...
The Java docs for Logger indicate that the logger name should be based on the class name. Google Guice handles this in BinderImpl.java where it does the following: return member == null ? Logger.getAnonymousLogger() : Logger.getLogger(member.getDeclaringClass().getName()); However, since it's getting a new logger for each class, I would lose access to whatever Handler's may have...
NetBeans recommended that I change the way that logging statements that have string concatenation are written, stating Convert string concatenation to a message template so that a statement such as: log.severe("Completed at: " + new Date()); got changed to log.log(Level.SEVERE, "Completed at: {0}", new Date()); The problem is that now the Date doesn't get printed. Instead, the string "{...
Is there a way to report log messages in a Client-side GWT applications for development purposes (in Standard GWT libraries i.e. No external libraries)? i.e. like the Logger that can be used to output log messages to catalina.out when developing things for say Tomcat.
From java.util.logging.Logger: Logger names can be arbitrary strings, but they should normally be based on the package name or class name of the logged component, such as java.net or javax.swing Could anyone explain this sentence to me ?
HI All, I am developing one application their i need to use the logger for that i read all the levels of logger which are * SEVERE (highest) * WARNING * INFO * CONFIG * FINE * FINER * FINEST but i am not understand how to use that level can anyone give me the good example of all the levels and at what condition we can use all the levels and how? Thanks A lot...
   /*
    * Copyright 2000-2006 Sun Microsystems, Inc.  All Rights Reserved.
    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    *
    * This code is free software; you can redistribute it and/or modify it
    * under the terms of the GNU General Public License version 2 only, as
    * published by the Free Software Foundation.  Sun designates this
    * particular file as subject to the "Classpath" exception as provided
    * by Sun in the LICENSE file that accompanied this code.
   *
   * This code is distributed in the hope that it will be useful, but WITHOUT
   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   * version 2 for more details (a copy is included in the LICENSE file that
   * accompanied this code).
   *
   * You should have received a copy of the GNU General Public License version
   * 2 along with this work; if not, write to the Free Software Foundation,
   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
   * CA 95054 USA or visit www.sun.com if you need additional information or
   * have any questions.
   */
  
  
  package java.util.logging;
  
  import java.util.*;
  import java.security.*;
A Logger object is used to log messages for a specific system or application component. Loggers are normally named, using a hierarchical dot-separated namespace. Logger names can be arbitrary strings, but they should normally be based on the package name or class name of the logged component, such as java.net or javax.swing. In addition it is possible to create "anonymous" Loggers that are not stored in the Logger namespace.

Logger objects may be obtained by calls on one of the getLogger factory methods. These will either create a new Logger or return a suitable existing Logger.

Logging messages will be forwarded to registered Handler objects, which can forward the messages to a variety of destinations, including consoles, files, OS logs, etc.

Each Logger keeps track of a "parent" Logger, which is its nearest existing ancestor in the Logger namespace.

Each Logger has a "Level" associated with it. This reflects a minimum Level that this logger cares about. If a Logger's level is set to null, then its effective level is inherited from its parent, which may in turn obtain it recursively from its parent, and so on up the tree.

The log level can be configured based on the properties from the logging configuration file, as described in the description of the LogManager class. However it may also be dynamically changed by calls on the Logger.setLevel method. If a logger's level is changed the change may also affect child loggers, since any child logger that has null as its level will inherit its effective level from its parent.

On each logging call the Logger initially performs a cheap check of the request level (e.g. SEVERE or FINE) against the effective log level of the logger. If the request level is lower than the log level, the logging call returns immediately.

After passing this initial (cheap) test, the Logger will allocate a LogRecord to describe the logging message. It will then call a Filter (if present) to do a more detailed check on whether the record should be published. If that passes it will then publish the LogRecord to its output Handlers. By default, loggers also publish to their parent's Handlers, recursively up the tree.

Each Logger may have a ResourceBundle name associated with it. The named bundle will be used for localizing logging messages. If a Logger does not have its own ResourceBundle name, then it will inherit the ResourceBundle name from its parent, recursively up the tree.

Most of the logger output methods take a "msg" argument. This msg argument may be either a raw value or a localization key. During formatting, if the logger has (or inherits) a localization ResourceBundle and if the ResourceBundle has a mapping for the msg string, then the msg string is replaced by the localized value. Otherwise the original msg string is used. Typically, formatters use java.text.MessageFormat style formatting to format parameters, so for example a format string "{0} {1}" would format two parameters as strings.

When mapping ResourceBundle names to ResourceBundles, the Logger will first try to use the Thread's ContextClassLoader. If that is null it will try the SystemClassLoader instead. As a temporary transition feature in the initial implementation, if the Logger is unable to locate a ResourceBundle from the ContextClassLoader or SystemClassLoader the Logger will also search up the class stack and use successive calling ClassLoaders to try to locate a ResourceBundle. (This call stack search is to allow containers to transition to using ContextClassLoaders and is likely to be removed in future versions.)

Formatting (including localization) is the responsibility of the output Handler, which will typically call a Formatter.

Note that formatting need not occur synchronously. It may be delayed until a LogRecord is actually written to an external sink.

The logging methods are grouped in five main categories:

  • There are a set of "log" methods that take a log level, a message string, and optionally some parameters to the message string.

  • There are a set of "logp" methods (for "log precise") that are like the "log" methods, but also take an explicit source class name and method name.

  • There are a set of "logrb" method (for "log with resource bundle") that are like the "logp" method, but also take an explicit resource bundle name for use in localizing the log message.

  • There are convenience methods for tracing method entries (the "entering" methods), method returns (the "exiting" methods) and throwing exceptions (the "throwing" methods).

  • Finally, there are a set of convenience methods for use in the very simplest cases, when a developer simply wants to log a simple string at a given log level. These methods are named after the standard Level names ("severe", "warning", "info", etc.) and take a single argument, a message string.

For the methods that do not take an explicit source name and method name, the Logging framework will make a "best effort" to determine which class and method called into the logging method. However, it is important to realize that this automatically inferred information may only be approximate (or may even be quite wrong!). Virtual machines are allowed to do extensive optimizations when JITing and may entirely remove stack frames, making it impossible to reliably locate the calling class and method.

All methods on Logger are multi-thread safe.

Subclassing Information: Note that a LogManager class may provide its own implementation of named Loggers for any point in the namespace. Therefore, any subclasses of Logger (unless they are implemented in conjunction with a new LogManager class) should take care to obtain a Logger instance from the LogManager class and should delegate operations such as "isLoggable" and "log(LogRecord)" to that instance. Note that in order to intercept all logging output, subclasses need only override the log(LogRecord) method. All the other logging methods are implemented as calls on this log(LogRecord) method.

Since:
1.4
 
 
 
 public class Logger {
     private static final Handler emptyHandlers[] = new Handler[0];
     private static final int offValue = ..intValue();
     private LogManager manager;
     private String name;
     private ArrayList<Handlerhandlers;
     private String resourceBundleName;
     private boolean useParentHandlers = true;
     private Filter filter;
     private boolean anonymous;
 
     private ResourceBundle catalog;     // Cached resource bundle
     private String catalogName;         // name associated with catalog
     private Locale catalogLocale;       // locale associated with catalog
 
     // The fields relating to parent-child relationships and levels
     // are managed under a separate lock, the treeLock.
     private static Object treeLock = new Object();
     // We keep weak references from parents to children, but strong
     // references from children to parents.
     private Logger parent;    // our nearest parent.
     private ArrayList<WeakReference<Logger>> kids;   // WeakReferences to loggers that have us as parent
     private Level levelObject;
     private volatile int levelValue;  // current effective level value
 
    
GLOBAL_LOGGER_NAME is a name for the global logger. This name is provided as a convenience to developers who are making casual use of the Logging package. Developers who are making serious use of the logging package (for example in products) should create and use their own Logger objects, with appropriate names, so that logging can be controlled on a suitable per-Logger granularity.

The preferred way to get the global logger object is via the call Logger.getLogger(Logger.GLOBAL_LOGGER_NAME).

Since:
1.6
 
     public static final String GLOBAL_LOGGER_NAME = "global";

    
The "global" Logger object is provided as a convenience to developers who are making casual use of the Logging package. Developers who are making serious use of the logging package (for example in products) should create and use their own Logger objects, with appropriate names, so that logging can be controlled on a suitable per-Logger granularity.

Deprecated:
Initialization of this field is prone to deadlocks. The field must be initialized by the Logger class initialization which may cause deadlocks with the LogManager class initialization. In such cases two class initialization wait for each other to complete. As of JDK version 1.6, the preferred way to get the global logger object is via the call Logger.getLogger(Logger.GLOBAL_LOGGER_NAME).
 
     @Deprecated
     public static final Logger global = new Logger();

    
Protected method to construct a logger for a named subsystem.

The logger will be initially configured with a null Level and with useParentHandlers true.

Parameters:
name A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing. It may be null for anonymous Loggers.
resourceBundleName name of ResourceBundle to be used for localizing messages for this logger. May be null if none of the messages require localization.
Throws:
java.util.MissingResourceException if the ResourceBundleName is non-null and no corresponding resource can be found.
 
     protected Logger(String nameString resourceBundleName) {
         this. = LogManager.getLogManager();
         if (resourceBundleName != null) {
             // Note: we may get a MissingResourceException here.
             setupResourceInfo(resourceBundleName);
         }
         this. = name;
          = ..intValue();
     }
 
     // This constructor is used only to create the global Logger.
     // It is needed to break a cyclic dependence between the LogManager
     // and Logger static initializers causing deadlocks.
     private Logger(String name) {
         // The manager field is not initialized here.
         this. = name;
          = ..intValue();
     }
 
     // It is called from the LogManager.<clinit> to complete
     // initialization of the global Logger.
     void setLogManager(LogManager manager) {
         this. = manager;
     }
 
     private void checkAccess() throws SecurityException {
         if (!) {
             if ( == null) {
                 // Complete initialization of the global Logger.
                  = LogManager.getLogManager();
             }
             .checkAccess();
         }
     }

    
Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager configuration and it will configured to also send logging output to its parent's handlers. It will be registered in the LogManager global namespace.

Parameters:
name A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing
Returns:
a suitable Logger
Throws:
java.lang.NullPointerException if the name is null.
 
     public static synchronized Logger getLogger(String name) {
         LogManager manager = LogManager.getLogManager();
         return manager.demandLogger(name);
     }

    
Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager and it will configured to also send logging output to its parent loggers Handlers. It will be registered in the LogManager global namespace.

If the named Logger already exists and does not yet have a localization resource bundle then the given resource bundle name is used. If the named Logger already exists and has a different resource bundle name then an IllegalArgumentException is thrown.

Parameters:
name A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing
resourceBundleName name of ResourceBundle to be used for localizing messages for this logger. May be null if none of the messages require localization.
Returns:
a suitable Logger
Throws:
java.util.MissingResourceException if the named ResourceBundle cannot be found.
java.lang.IllegalArgumentException if the Logger already exists and uses a different resource bundle name.
java.lang.NullPointerException if the name is null.
 
     public static synchronized Logger getLogger(String nameString resourceBundleName) {
         LogManager manager = LogManager.getLogManager();
         Logger result = manager.demandLogger(name);
         if (result.resourceBundleName == null) {
             // Note: we may get a MissingResourceException here.
             result.setupResourceInfo(resourceBundleName);
         } else if (!result.resourceBundleName.equals(resourceBundleName)) {
             throw new IllegalArgumentException(result.resourceBundleName +
                                 " != " + resourceBundleName);
         }
         return result;
     }


    
Create an anonymous Logger. The newly created Logger is not registered in the LogManager namespace. There will be no access checks on updates to the logger.

This factory method is primarily intended for use from applets. Because the resulting Logger is anonymous it can be kept private by the creating class. This removes the need for normal security checks, which in turn allows untrusted applet code to update the control state of the Logger. For example an applet can do a setLevel or an addHandler on an anonymous Logger.

Even although the new logger is anonymous, it is configured to have the root logger ("") as its parent. This means that by default it inherits its effective level and handlers from the root logger.

Returns:
a newly created private Logger
 
     public static synchronized Logger getAnonymousLogger() {
         LogManager manager = LogManager.getLogManager();
         Logger result = new Logger(nullnull);
         result.anonymous = true;
         Logger root = manager.getLogger("");
         result.doSetParent(root);
         return result;
     }

    
Create an anonymous Logger. The newly created Logger is not registered in the LogManager namespace. There will be no access checks on updates to the logger.

This factory method is primarily intended for use from applets. Because the resulting Logger is anonymous it can be kept private by the creating class. This removes the need for normal security checks, which in turn allows untrusted applet code to update the control state of the Logger. For example an applet can do a setLevel or an addHandler on an anonymous Logger.

Even although the new logger is anonymous, it is configured to have the root logger ("") as its parent. This means that by default it inherits its effective level and handlers from the root logger.

Parameters:
resourceBundleName name of ResourceBundle to be used for localizing messages for this logger. May be null if none of the messages require localization.
Returns:
a newly created private Logger
Throws:
java.util.MissingResourceException if the named ResourceBundle cannot be found.
 
     public static synchronized Logger getAnonymousLogger(String resourceBundleName) {
         LogManager manager = LogManager.getLogManager();
         Logger result = new Logger(nullresourceBundleName);
         result.anonymous = true;
         Logger root = manager.getLogger("");
         result.doSetParent(root);
         return result;
     }

    
Retrieve the localization resource bundle for this logger for the current default locale. Note that if the result is null, then the Logger will use a resource bundle inherited from its parent.

Returns:
localization bundle (may be null)
 
     public ResourceBundle getResourceBundle() {
         return findResourceBundle(getResourceBundleName());
     }

    
Retrieve the localization resource bundle name for this logger. Note that if the result is null, then the Logger will use a resource bundle name inherited from its parent.

Returns:
localization bundle name (may be null)
 
     public String getResourceBundleName() {
         return ;
     }

    
Set a filter to control output on this Logger.

After passing the initial "level" check, the Logger will call this Filter to check if a log record should really be published.

Parameters:
newFilter a filter object (may be null)
Throws:
java.lang.SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
 
     public synchronized void setFilter(Filter newFilterthrows SecurityException {
         checkAccess();
          = newFilter;
     }

    
Get the current filter for this Logger.

Returns:
a filter object (may be null)
 
     public synchronized Filter getFilter() {
         return ;
     }

    
Log a LogRecord.

All the other logging methods in this class call through this method to actually perform any logging. Subclasses can override this single method to capture all log activity.

Parameters:
record the LogRecord to be published
 
     public void log(LogRecord record) {
         if (record.getLevel().intValue() <  ||  == ) {
             return;
         }
         synchronized (this) {
             if ( != null && !.isLoggable(record)) {
                 return;
             }
         }
 
         // Post the LogRecord to all our Handlers, and then to
         // our parents' handlers, all the way up the tree.
 
         Logger logger = this;
         while (logger != null) {
             Handler targets[] = logger.getHandlers();
 
             if (targets != null) {
                 for (int i = 0; i < targets.lengthi++) {
                     targets[i].publish(record);
                 }
             }
 
             if (!logger.getUseParentHandlers()) {
                 break;
             }
 
             logger = logger.getParent();
         }
     }
 
     // private support method for logging.
     // We fill in the logger name, resource bundle name, and
     // resource bundle and then call "void log(LogRecord)".
     private void doLog(LogRecord lr) {
         lr.setLoggerName();
         String ebname = getEffectiveResourceBundleName();
         if (ebname != null) {
             lr.setResourceBundleName(ebname);
             lr.setResourceBundle(findResourceBundle(ebname));
         }
         log(lr);
     }
 
 
     //================================================================
     // Start of convenience methods WITHOUT className and methodName
     //================================================================
 
    
Log a message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
level One of the message level identifiers, e.g. SEVERE
msg The string message (or a key in the message catalog)
 
     public void log(Level levelString msg) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         doLog(lr);
     }

    
Log a message, with one object parameter.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:
level One of the message level identifiers, e.g. SEVERE
msg The string message (or a key in the message catalog)
param1 parameter to the message
 
     public void log(Level levelString msgObject param1) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         Object params[] = { param1 };
         lr.setParameters(params);
         doLog(lr);
     }

    
Log a message, with an array of object arguments.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:
level One of the message level identifiers, e.g. SEVERE
msg The string message (or a key in the message catalog)
params array of parameters to the message
 
     public void log(Level levelString msgObject params[]) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setParameters(params);
         doLog(lr);
     }

    
Log a message, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:
level One of the message level identifiers, e.g. SEVERE
msg The string message (or a key in the message catalog)
thrown Throwable associated with log message.
 
     public void log(Level levelString msgThrowable thrown) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setThrown(thrown);
         doLog(lr);
     }
 
     //================================================================
     // Start of convenience methods WITH className and methodName
     //================================================================
 
    
Log a message, specifying source class and method, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
msg The string message (or a key in the message catalog)
 
     public void logp(Level levelString sourceClassString sourceMethodString msg) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         doLog(lr);
     }

    
Log a message, specifying source class and method, with a single object parameter to the log message.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
msg The string message (or a key in the message catalog)
param1 Parameter to the log message.
 
     public void logp(Level levelString sourceClassString sourceMethod,
                                                 String msgObject param1) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         Object params[] = { param1 };
         lr.setParameters(params);
         doLog(lr);
     }

    
Log a message, specifying source class and method, with an array of object arguments.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
msg The string message (or a key in the message catalog)
params Array of parameters to the message
 
     public void logp(Level levelString sourceClassString sourceMethod,
                                                 String msgObject params[]) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         lr.setParameters(params);
         doLog(lr);
     }

    
Log a message, specifying source class and method, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
msg The string message (or a key in the message catalog)
thrown Throwable associated with log message.
 
     public void logp(Level levelString sourceClassString sourceMethod,
                                                         String msgThrowable thrown) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         lr.setThrown(thrown);
         doLog(lr);
     }
 
 
     //=========================================================================
     // Start of convenience methods WITH className, methodName and bundle name.
     //=========================================================================
 
     // Private support method for logging for "logrb" methods.
     // We fill in the logger name, resource bundle name, and
     // resource bundle and then call "void log(LogRecord)".
     private void doLog(LogRecord lrString rbname) {
         lr.setLoggerName();
         if (rbname != null) {
             lr.setResourceBundleName(rbname);
             lr.setResourceBundle(findResourceBundle(rbname));
         }
         log(lr);
     }

    
Log a message, specifying source class, method, and resource bundle name with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

The msg string is localized using the named resource bundle. If the resource bundle name is null, or an empty String or invalid then the msg string is not localized.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
bundleName name of resource bundle to localize msg, can be null
msg The string message (or a key in the message catalog)
 
 
     public void logrb(Level levelString sourceClassString sourceMethod,
                                 String bundleNameString msg) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         doLog(lrbundleName);
     }

    
Log a message, specifying source class, method, and resource bundle name, with a single object parameter to the log message.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

The msg string is localized using the named resource bundle. If the resource bundle name is null, or an empty String or invalid then the msg string is not localized.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
bundleName name of resource bundle to localize msg, can be null
msg The string message (or a key in the message catalog)
param1 Parameter to the log message.
 
     public void logrb(Level levelString sourceClassString sourceMethod,
                                 String bundleNameString msgObject param1) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         Object params[] = { param1 };
         lr.setParameters(params);
         doLog(lrbundleName);
     }

    
Log a message, specifying source class, method, and resource bundle name, with an array of object arguments.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

The msg string is localized using the named resource bundle. If the resource bundle name is null, or an empty String or invalid then the msg string is not localized.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
bundleName name of resource bundle to localize msg, can be null.
msg The string message (or a key in the message catalog)
params Array of parameters to the message
 
     public void logrb(Level levelString sourceClassString sourceMethod,
                                 String bundleNameString msgObject params[]) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         lr.setParameters(params);
         doLog(lrbundleName);
     }

    
Log a message, specifying source class, method, and resource bundle name, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

The msg string is localized using the named resource bundle. If the resource bundle name is null, or an empty String or invalid then the msg string is not localized.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:
level One of the message level identifiers, e.g. SEVERE
sourceClass name of class that issued the logging request
sourceMethod name of method that issued the logging request
bundleName name of resource bundle to localize msg, can be null
msg The string message (or a key in the message catalog)
thrown Throwable associated with log message.
 
     public void logrb(Level levelString sourceClassString sourceMethod,
                                         String bundleNameString msgThrowable thrown) {
         if (level.intValue() <  ||  == ) {
             return;
         }
         LogRecord lr = new LogRecord(levelmsg);
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         lr.setThrown(thrown);
         doLog(lrbundleName);
     }
 
 
     //======================================================================
     // Start of convenience methods for logging method entries and returns.
     //======================================================================
 
    
Log a method entry.

This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY", log level FINER, and the given sourceMethod and sourceClass is logged.

Parameters:
sourceClass name of class that issued the logging request
sourceMethod name of method that is being entered
 
     public void entering(String sourceClassString sourceMethod) {
         if (..intValue() < ) {
             return;
         }
         logp(.sourceClasssourceMethod"ENTRY");
     }

    
Log a method entry, with one parameter.

This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY {0}", log level FINER, and the given sourceMethod, sourceClass, and parameter is logged.

Parameters:
sourceClass name of class that issued the logging request
sourceMethod name of method that is being entered
param1 parameter to the method being entered
 
     public void entering(String sourceClassString sourceMethodObject param1) {
         if (..intValue() < ) {
             return;
         }
         Object params[] = { param1 };
         logp(.sourceClasssourceMethod"ENTRY {0}"params);
     }

    
Log a method entry, with an array of parameters.

This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY" (followed by a format {N} indicator for each entry in the parameter array), log level FINER, and the given sourceMethod, sourceClass, and parameters is logged.

Parameters:
sourceClass name of class that issued the logging request
sourceMethod name of method that is being entered
params array of parameters to the method being entered
 
     public void entering(String sourceClassString sourceMethodObject params[]) {
         if (..intValue() < ) {
             return;
         }
         String msg = "ENTRY";
         if (params == null ) {
            logp(.sourceClasssourceMethodmsg);
            return;
         }
         for (int i = 0; i < params.lengthi++) {
             msg = msg + " {" + i + "}";
         }
         logp(.sourceClasssourceMethodmsgparams);
     }

    
Log a method return.

This is a convenience method that can be used to log returning from a method. A LogRecord with message "RETURN", log level FINER, and the given sourceMethod and sourceClass is logged.

Parameters:
sourceClass name of class that issued the logging request
sourceMethod name of the method
 
     public void exiting(String sourceClassString sourceMethod) {
         if (..intValue() < ) {
             return;
         }
         logp(.sourceClasssourceMethod"RETURN");
     }


    
Log a method return, with result object.

This is a convenience method that can be used to log returning from a method. A LogRecord with message "RETURN {0}", log level FINER, and the gives sourceMethod, sourceClass, and result object is logged.

Parameters:
sourceClass name of class that issued the logging request
sourceMethod name of the method
result Object that is being returned
 
     public void exiting(String sourceClassString sourceMethodObject result) {
         if (..intValue() < ) {
             return;
         }
         Object params[] = { result };
         logp(.sourceClasssourceMethod"RETURN {0}"result);
     }

    
Log throwing an exception.

This is a convenience method to log that a method is terminating by throwing an exception. The logging is done using the FINER level.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers. The LogRecord's message is set to "THROW".

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:
sourceClass name of class that issued the logging request
sourceMethod name of the method.
thrown The Throwable that is being thrown.
 
     public void throwing(String sourceClassString sourceMethodThrowable thrown) {
         if (..intValue() <  ||  ==  ) {
             return;
         }
         LogRecord lr = new LogRecord(."THROW");
         lr.setSourceClassName(sourceClass);
         lr.setSourceMethodName(sourceMethod);
         lr.setThrown(thrown);
         doLog(lr);
     }
 
     //=======================================================================
     // Start of simple convenience methods using level names as method names
     //=======================================================================
 
    
Log a SEVERE message.

If the logger is currently enabled for the SEVERE message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void severe(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }

    
Log a WARNING message.

If the logger is currently enabled for the WARNING message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void warning(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }

    
Log an INFO message.

If the logger is currently enabled for the INFO message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void info(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }

    
Log a CONFIG message.

If the logger is currently enabled for the CONFIG message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void config(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }

    
Log a FINE message.

If the logger is currently enabled for the FINE message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void fine(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }

    
Log a FINER message.

If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void finer(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }

    
Log a FINEST message.

If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects.

Parameters:
msg The string message (or a key in the message catalog)
    public void finest(String msg) {
        if (..intValue() < ) {
            return;
        }
        log(.msg);
    }
    //================================================================
    // End of convenience methods
    //================================================================

    
Set the log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded. The level value Level.OFF can be used to turn off logging.

If the new level is null, it means that this node should inherit its level from its nearest ancestor with a specific (non-null) level value.

Parameters:
newLevel the new value for the log level (may be null)
Throws:
java.lang.SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
    public void setLevel(Level newLevelthrows SecurityException {
        checkAccess();
        synchronized () {
             = newLevel;
            updateEffectiveLevel();
        }
    }

    
Get the log Level that has been specified for this Logger. The result may be null, which means that this logger's effective level will be inherited from its parent.

Returns:
this Logger's level
    public Level getLevel() {
        return ;
    }

    
Check if a message of the given level would actually be logged by this logger. This check is based on the Loggers effective level, which may be inherited from its parent.

Parameters:
level a message logging level
Returns:
true if the given message level is currently being logged.
    public boolean isLoggable(Level level) {
        if (level.intValue() <  ||  == ) {
            return false;
        }
        return true;
    }

    
Get the name for this logger.

Returns:
logger name. Will be null for anonymous Loggers.
    public String getName() {
        return ;
    }

    
Add a log Handler to receive logging messages.

By default, Loggers also send their output to their parent logger. Typically the root Logger is configured with a set of Handlers that essentially act as default handlers for all loggers.

Parameters:
handler a logging Handler
Throws:
java.lang.SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
    public synchronized void addHandler(Handler handlerthrows SecurityException {
        // Check for null handler
        handler.getClass();
        checkAccess();
        if ( == null) {
             = new ArrayList<Handler>();
        }
        .add(handler);
    }

    
Remove a log Handler.

Returns silently if the given Handler is not found or is null

Parameters:
handler a logging Handler
Throws:
java.lang.SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
    public synchronized void removeHandler(Handler handlerthrows SecurityException {
        checkAccess();
        if (handler == null) {
            return;
        }
        if ( == null) {
            return;
        }
        .remove(handler);
    }

    
Get the Handlers associated with this logger.

Returns:
an array of all registered Handlers
    public synchronized Handler[] getHandlers() {
        if ( == null) {
            return ;
        }
        return .toArray(new Handler[.size()]);
    }

    
Specify whether or not this logger should send its output to it's parent Logger. This means that any LogRecords will also be written to the parent's Handlers, and potentially to its parent, recursively up the namespace.

Parameters:
useParentHandlers true if output is to be sent to the logger's parent.
Throws:
java.lang.SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
    public synchronized void setUseParentHandlers(boolean useParentHandlers) {
        checkAccess();
        this. = useParentHandlers;
    }

    
Discover whether or not this logger is sending its output to its parent logger.

Returns:
true if output is to be sent to the logger's parent
    public synchronized boolean getUseParentHandlers() {
        return ;
    }
    // Private utility method to map a resource bundle name to an
    // actual resource bundle, using a simple one-entry cache.
    // Returns null for a null name.
    // May also return null if we can't find the resource bundle and
    // there is no suitable previous cached value.
    private synchronized ResourceBundle findResourceBundle(String name) {
        // Return a null bundle for a null name.
        if (name == null) {
            return null;
        }
        Locale currentLocale = Locale.getDefault();
        // Normally we should hit on our simple one entry cache.
        if ( != null && currentLocale == 
                                        && name == ) {
            return ;
        }
        // Use the thread's context ClassLoader.  If there isn't one,
        // use the SystemClassloader.
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        if (cl == null) {
            cl = ClassLoader.getSystemClassLoader();
        }
        try {
             = ResourceBundle.getBundle(namecurrentLocalecl);
             = name;
             = currentLocale;
            return ;
        } catch (MissingResourceException ex) {
            // Woops.  We can't find the ResourceBundle in the default
            // ClassLoader.  Drop through.
        }
        // Fall back to searching up the call stack and trying each
        // calling ClassLoader.
        for (int ix = 0; ; ix++) {
            Class clz = sun.reflect.Reflection.getCallerClass(ix);
            if (clz == null) {
                break;
            }
            ClassLoader cl2 = clz.getClassLoader();
            if (cl2 == null) {
                cl2 = ClassLoader.getSystemClassLoader();
            }
            if (cl == cl2) {
                // We've already checked this classloader.
                continue;
            }
            cl = cl2;
            try {
                 = ResourceBundle.getBundle(namecurrentLocalecl);
                 = name;
                 = currentLocale;
                return ;
            } catch (MissingResourceException ex) {
                // Ok, this one didn't work either.
                // Drop through, and try the next one.
            }
        }
        if (name.equals()) {
            // Return the previous cached value for that name.
            // This may be null.
            return ;
        }
        // Sorry, we're out of luck.
        return null;
    }
    // Private utility method to initialize our one entry
    // resource bundle cache.
    // Note: for consistency reasons, we are careful to check
    // that a suitable ResourceBundle exists before setting the
    // ResourceBundleName.
    private synchronized void setupResourceInfo(String name) {
        if (name == null) {
            return;
        }
        ResourceBundle rb = findResourceBundle(name);
        if (rb == null) {
            // We've failed to find an expected ResourceBundle.
            throw new MissingResourceException("Can't find " + name + " bundle"name"");
        }
         = name;
    }

    
Return the parent for this Logger.

This method returns the nearest extant parent in the namespace. Thus if a Logger is called "a.b.c.d", and a Logger called "a.b" has been created but no logger "a.b.c" exists, then a call of getParent on the Logger "a.b.c.d" will return the Logger "a.b".

The result will be null if it is called on the root Logger in the namespace.

Returns:
nearest existing parent Logger
    public Logger getParent() {
        synchronized () {
            return ;
        }
    }

    
Set the parent for this Logger. This method is used by the LogManager to update a Logger when the namespace changes.

It should not be called from application code.

Parameters:
parent the new parent logger
Throws:
java.lang.SecurityException if a security manager exists and if the caller does not have LoggingPermission("control").
    public void setParent(Logger parent) {
        if (parent == null) {
            throw new NullPointerException();
        }
        .checkAccess();
        doSetParent(parent);
    }
    // Private method to do the work for parenting a child
    // Logger onto a parent logger.
    private void doSetParent(Logger newParent) {
        // System.err.println("doSetParent \"" + getName() + "\" \""
        //                              + newParent.getName() + "\"");
        synchronized () {
            // Remove ourself from any previous parent.
            if ( != null) {
                // assert parent.kids != null;
                for (Iterator<WeakReference<Logger>> iter = ..iterator(); iter.hasNext(); ) {
                    WeakReference<Loggerref =  iter.next();
                    Logger kid =  ref.get();
                    if (kid == this) {
                        iter.remove();
                        break;
                    }
                }
                // We have now removed ourself from our parents' kids.
            }
            // Set our new parent.
             = newParent;
            if (. == null) {
                . = new ArrayList<WeakReference<Logger>>(2);
            }
            ..add(new WeakReference<Logger>(this));
            // As a result of the reparenting, the effective level
            // may have changed for us and our children.
            updateEffectiveLevel();
        }
    }
    // Recalculate the effective level for this node and
    // recursively for our children.
    private void updateEffectiveLevel() {
        // assert Thread.holdsLock(treeLock);
        // Figure out our current effective level.
        int newLevelValue;
        if ( != null) {
            newLevelValue = .intValue();
        } else {
            if ( != null) {
                newLevelValue = .;
            } else {
                // This may happen during initialization.
                newLevelValue = ..intValue();
            }
        }
        // If our effective value hasn't changed, we're done.
        if ( == newLevelValue) {
            return;
        }
         = newLevelValue;
        // System.err.println("effective level: \"" + getName() + "\" := " + level);
        // Recursively update the level on each of our kids.
        if ( != null) {
            for (int i = 0; i < .size(); i++) {
                WeakReference<Loggerref = .get(i);
                Logger kid =  ref.get();
                if (kid != null) {
                    kid.updateEffectiveLevel();
                }
            }
        }
    }
    // Private method to get the potentially inherited
    // resource bundle name for this Logger.
    // May return null
        Logger target = this;
        while (target != null) {
            String rbn = target.getResourceBundleName();
            if (rbn != null) {
                return rbn;
            }
            target = target.getParent();
        }
        return null;
    }
New to GrepCode? Check out our FAQ X