/*
* JBoss, Home of Professional Open Source
* Copyright 2009, Red Hat Middleware LLC, and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed 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.jboss.shrinkwrap.api;
ExtensionLoader Describes a way for the Archive
to load extensions. If an implementation is not set in the Domain
's Configuration
, ServiceExtensionLoader
is set as the default strategy to load extensions. Author: Aslak Knutsen, Ken Gullaksen Version: $Revision: $
/**
* ExtensionLoader
*
* Describes a way for the {@link Archive} to load extensions. If an implementation is not set in the {@link Domain}'s
* {@link Configuration}, {@link ServiceExtensionLoader} is set as the default strategy to load extensions.
*
* @author <a href="mailto:aslak@conduct.no">Aslak Knutsen</a>
* @author <a href="mailto:ken@glxn.net">Ken Gullaksen</a>
* @version $Revision: $
*/
public interface ExtensionLoader {
Load a Extension.
Params: - extensionClass –
The Extension interface
- baseArchive –
The base archive to use
Type parameters: - <T> –
Returns: a
/**
* Load a Extension.
*
* @param <T>
* @param extensionClass
* The Extension interface
* @param baseArchive
* The base archive to use
* @return a
*/
<T extends Assignable> T load(Class<T> extensionClass, Archive<?> baseArchive);
Add a Override to the normal Extension loading.
If a specific class is found to be overridden, the class will not be loaded using the normal strategy.
Params: - extensionClass –
The Extension interface class
- extensionImplClass –
The Extension implementation class
Type parameters: - <T> –
The type of Extension
Returns: this ExtensionLoader
/**
* Add a Override to the normal Extension loading.
*
* If a specific class is found to be overridden, the class will not be loaded using the normal strategy.
*
* @param <T>
* The type of Extension
* @param extensionClass
* The Extension interface class
* @param extensionImplClass
* The Extension implementation class
* @return this ExtensionLoader
*/
<T extends Assignable> ExtensionLoader addOverride(Class<T> extensionClass,
Class<? extends T> extensionImplClass);
Gets the extension for the given type from the extensionMapping
Params: - extensionClass –
The Extension interface class
Type parameters: - <T> –
The type of Extension
Returns: the filename extension
/**
* Gets the extension for the given type from the extensionMapping
*
* @param extensionClass
* The Extension interface class
* @param <T>
* The type of Extension
* @return the filename extension
*/
<T extends Assignable> String getExtensionFromExtensionMapping(Class<T> extensionClass);
Gets the ArchiveFormat
for the given type from the extensionMapping Params: - extensionClass –
The Extension interface class
Type parameters: - <T> –
The type of Extension
Returns: the archive format
/**
* Gets the {@link org.jboss.shrinkwrap.api.ArchiveFormat} for the given type from the extensionMapping
*
* @param extensionClass
* The Extension interface class
* @param <T>
* The type of Extension
* @return the archive format
*/
<T extends Archive<T>> ArchiveFormat getArchiveFormatFromExtensionMapping(Class<T> extensionClass);
}