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.siterenderer;
20
21 import org.apache.velocity.context.Context;
22
23 /**
24 * A callback interface to customize the Velocity {@link Context} before rendering a document.
25 **/
26 @FunctionalInterface
27 public interface ContextCustomizer {
28
29 /**
30 * Customize the Velocity context before rendering a document.
31 *
32 * @param context the Velocity context to customize.
33 * @param docRenderingContext the document rendering context for the document being rendered.
34 * @param siteRenderingContext the site rendering context for the site being rendered.
35 */
36 void customizeContext(
37 Context context, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteRenderingContext);
38 }