doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/LogEnabled.java

package org.apache.maven.doxia.logging;

/*
 * 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.
 */


/**
 * An interface for <code>Doxia</code> components (mainly Sink, Parser and Macro) that need the ability to log.
 * <br>
 * Based on <code>org.codehaus.plexus.logging.LogEnabled</code>.
 *
 * @author ltheussl
 * @since 1.1
 */
public interface LogEnabled
{
    /**
     * Enable a <code>Doxia</code> logger for this <code>Doxia</code> component.
     *
     * @param log a Log.
     */
    void enableLogging( Log log );
}