org.wicketstuff.jslibraries.Provider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-jslibraries Show documentation

This project is simply a unified way of including common JS libraries within Wicket so that you don't have to bundle them in your application, and they aren't deployed with dozens of jars that may use them, but they are deployed in only one.

There is a newer version: 6.30.0

Show newest version

/**
 * Copyright (C) 2009 Uwe Schaefer 
 *
 * 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.wicketstuff.jslibraries;

import org.apache.wicket.markup.html.IHeaderContributor;

/**
 * A Provider is an optional means of overriding the HeaderContributor created by JSLib. 

 * If you use 
 * JSLib.getHeaderContributor(versionDescriptor, provider[]) , these providers get the
 * opportunity to provide a HeaderContributor first. If it returns null, the requested lib will be
 * served from the application instead (if defined).
 * 
 * @author Uwe Schäfer, ([email protected])
 */
public interface Provider
{

	/**
	 * @param versionDescriptor
	 * @param productionHint
	 *            if true, tries to use minimized version of script if available
	 * @return HeaderContributor to be added to component, or null if unavailable
	 */
	public IHeaderContributor getHeaderContributor(VersionDescriptor versionDescriptor,
		boolean productionHint);

}