src.java.util.logging.ConsoleHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
There is a newer version: 15-robolectric-12650502
/*
 * Copyright (c) 2000, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


package java.util.logging;

/**
 * This Handler publishes log records to System.err.
 * By default the SimpleFormatter is used to generate brief summaries.
 * 
 * Configuration:
 * By default each ConsoleHandler is initialized using the following
 * LogManager configuration properties where {@code }
 * refers to the fully-qualified class name of the handler.
 * If properties are not defined
 * (or have invalid values) then the specified default values are used.
 * 

 *    <handler-name>.level
 *        specifies the default level for the Handler
 *        (defaults to Level.INFO). 
 *    <handler-name>.filter
 *        specifies the name of a Filter class to use
 *        (defaults to no Filter). 
 *    <handler-name>.formatter
 *        specifies the name of a Formatter class to use
 *        (defaults to java.util.logging.SimpleFormatter). 
 *    <handler-name>.encoding
 *        the name of the character set encoding to use (defaults to
 *        the default platform encoding). 
 * 
 * 
 * For example, the properties for {@code ConsoleHandler} would be:
 * 

 *    java.util.logging.ConsoleHandler.level=INFO 
 *    java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter 
 * 
 * 
 * For a custom handler, e.g. com.foo.MyHandler, the properties would be:
 * 

 *    com.foo.MyHandler.level=INFO 
 *    com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter 
 * 
 * 
 * @since 1.4
 */
public class ConsoleHandler extends StreamHandler {
    // Private method to configure a ConsoleHandler from LogManager
    // properties and/or default values as specified in the class
    // javadoc.
    private void configure() {
        LogManager manager = LogManager.getLogManager();
        String cname = getClass().getName();

        setLevel(manager.getLevelProperty(cname +".level", Level.INFO));
        setFilter(manager.getFilterProperty(cname +".filter", null));
        setFormatter(manager.getFormatterProperty(cname +".formatter", new SimpleFormatter()));
        try {
            setEncoding(manager.getStringProperty(cname +".encoding", null));
        } catch (Exception ex) {
            try {
                setEncoding(null);
            } catch (Exception ex2) {
                // doing a setEncoding with null should always work.
                // assert false;
            }
        }
    }

    /**
     * Create a ConsoleHandler for System.err.
     * 

     * The ConsoleHandler is configured based on
     * LogManager properties (or their default values).
     *
     */
    public ConsoleHandler() {
        sealed = false;
        configure();
        setOutputStream(System.err);
        sealed = true;
    }

    /**
     * Publish a LogRecord.
     * 

     * The logging request was made initially to a Logger object,
     * which initialized the LogRecord and forwarded it here.
     * 
     * @param  record  description of the log event. A null record is
     *                 silently ignored and is not published
     */
    @Override
    public void publish(LogRecord record) {
        super.publish(record);
        flush();
    }

    /**
     * Override StreamHandler.close to do a flush but not
     * to close the output stream.  That is, we do not
     * close System.err.
     */
    @Override
    public void close() {
        flush();
    }
}