001package org.apache.maven.doxia.logging;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022
023/**
024 * An interface for <code>Doxia</code> components (mainly Sink, Parser and Macro) that need the ability to log.
025 * <br/>
026 * Based on <code>org.codehaus.plexus.logging.LogEnabled</code>.
027 *
028 * @author ltheussl
029 * @version $Id$
030 * @since 1.1
031 */
032public interface LogEnabled
033{
034    /**
035     * Enable a <code>Doxia</code> logger for this <code>Doxia</code> component.
036     *
037     * @param log a Log.
038     */
039    void enableLogging( Log log );
040}