1 package org.apache.maven.doxia.logging;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22
23 /**
24 * An interface for <code>Doxia</code> components (mainly Sink, Parser and Macro) that need the ability to log.
25 * <br>
26 * Based on <code>org.codehaus.plexus.logging.LogEnabled</code>.
27 *
28 * @author ltheussl
29 * @since 1.1
30 */
31 public interface LogEnabled
32 {
33 /**
34 * Enable a <code>Doxia</code> logger for this <code>Doxia</code> component.
35 *
36 * @param log a Log.
37 */
38 void enableLogging( Log log );
39 }