001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.markup.transformer;
018
019import org.apache.wicket.Component;
020
021/**
022 * A common interface to be implemented by {@link org.apache.wicket.markup.transformer.AbstractOutputTransformerContainer}s
023 * and {@link org.apache.wicket.markup.transformer.AbstractTransformerBehavior}s which
024 * post-process the output markup of a component.
025 * 
026 * @author Juergen Donnerstag
027 */
028@FunctionalInterface
029public interface ITransformer
030{
031        /**
032         * Will be invoked after all child components have been processed to allow for transforming the
033         * markup generated.
034         * 
035         * @param component
036         *            The associated Wicket component
037         * @param output
038         *            The markup generated by the child components
039         * @return The output which will be appended to the original response
040         * @throws Exception
041         */
042        CharSequence transform(final Component component, final CharSequence output) throws Exception;
043}