001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.doxia.sink.impl;
020
021import org.apache.maven.doxia.sink.Sink;
022
023/**
024 * A factory for a sink wrapping another sink.
025 * The delegate may either be the original sink or another wrapper.
026 * @since 2.0.0
027 */
028public interface SinkWrapperFactory {
029
030    /**
031     * By default all wrappers just delegate each method to the wrapped sink's method.
032     * For certain Sink methods the wrapper may modify the sink before/after or instead of calling the delegate's method.
033     * @param sink the delegate
034     * @return a new sink wrapping the given one
035     */
036    Sink createWrapper(Sink sink);
037
038    /**
039     * Determines the order of sink wrappers. The wrapper factory with the highest priority is called first.
040     * @return the priority of this factory
041     */
042    int getPriority();
043}