org.apache.wicket.markup.loader.IMarkupLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.wicket.markup.loader;

import java.io.IOException;

import org.apache.wicket.MarkupContainer;
import org.apache.wicket.markup.Markup;
import org.apache.wicket.markup.MarkupCache;
import org.apache.wicket.markup.MarkupFactory;
import org.apache.wicket.markup.MarkupParser;
import org.apache.wicket.markup.MarkupResourceStream;
import org.apache.wicket.util.resource.ResourceStreamNotFoundException;

/**
 * IMarkupLoader are loading the markup for a specific Wicket container and resource stream. By
 * default that is a file. But e.g. in case of markup inheritance it means that 2+ markup files must
 * be read and merged. In order to be flexible the interface has been designed in a way that
 * multiple IMarkupLoader can be chained to easily build up more complex loaders.
 * 
 * As a Wicket user you should not need to use any markup loader directly. Instead use
 * {@link MarkupFactory#getMarkup(MarkupContainer, boolean)}.
 * 
 * @see MarkupCache
 * @see MarkupParser
 * @see MarkupFactory
 * 
 * @author Juergen Donnerstag
 */
public interface IMarkupLoader
{
	/**
	 * Loads markup from a resource stream.
	 * 
	 * @param container
	 *            The original requesting markup container
	 * @param markupResourceStream
	 *            The markup resource stream to load
	 * @param baseLoader
	 *            This parameter can be use to chain IMarkupLoaders
	 * @param enforceReload
	 *            The cache will be ignored and all, including inherited markup files, will be
	 *            reloaded. Whatever is in the cache, it will be ignored
	 * @return The markup
	 * @throws IOException
	 * @throws ResourceStreamNotFoundException
	 */
	Markup loadMarkup(final MarkupContainer container, MarkupResourceStream markupResourceStream,
		IMarkupLoader baseLoader, boolean enforceReload) throws IOException,
		ResourceStreamNotFoundException;
}