1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.maven.doxia.sink.impl; 20 21 import org.apache.maven.doxia.sink.Sink; 22 23 /** 24 * A factory for a sink wrapping another sink. 25 * The delegate may either be the original sink or another wrapper. 26 * @since 2.0.0 27 */ 28 public interface SinkWrapperFactory { 29 30 /** 31 * By default all wrappers just delegate each method to the wrapped sink's method. 32 * For certain Sink methods the wrapper may modify the sink before/after or instead of calling the delegate's method. 33 * @param sink the delegate 34 * @return a new sink wrapping the given one 35 */ 36 Sink createWrapper(Sink sink); 37 38 /** 39 * Determines the order of sink wrappers. The wrapper factory with the highest priority is called first. 40 * @return the priority of this factory 41 */ 42 int getPriority(); 43 }