org.apache.log4j.BasicConfigurator Maven / Gradle / Ivy
/*
* 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.
*/
// Contibutors: "Luke Blanshard"
// "Mark DONSZELMANN"
// "Muly Oved"
package org.apache.log4j;
/**
* Use this class to quickly configure the package.
*
*
* For file based configuration see {@link PropertyConfigurator}. For XML based
* configuration see {@link org.apache.log4j.xml.DOMConfigurator
* DOMConfigurator}.
*
* @since 0.8.1
* @author Ceki Gülcü
*/
public class BasicConfigurator {
protected BasicConfigurator() {
}
/**
* Add a {@link ConsoleAppender} that uses {@link PatternLayout} using the
* {@link PatternLayout#TTCC_CONVERSION_PATTERN} and prints to
* System.out to the root category.
*/
static public void configure() {
Logger root = Logger.getRootLogger();
root.addAppender(new ConsoleAppender(new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN)));
}
/**
* Add appender to the root category.
*
* @param appender The appender to add to the root category.
*/
static public void configure(Appender appender) {
Logger root = Logger.getRootLogger();
root.addAppender(appender);
}
/**
* Reset the default hierarchy to its defaut. It is equivalent to calling
* Category.getDefaultHierarchy().resetConfiguration().
*
* See {@link Hierarchy#resetConfiguration()} for more details.
*/
public static void resetConfiguration() {
LogManager.resetConfiguration();
}
}