org.jboss.shrinkwrap.resolver.api.ConfigurableResolverSystem Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-resolver-api Show documentation
Show all versions of shrinkwrap-resolver-api Show documentation
API to Resolve Dependencies from a Generic Backend
/*
* JBoss, Home of Professional Open Source
* Copyright 2012, 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.resolver.api;
import java.io.File;
/**
* Top-level of a configurable resolver system; subtypes may be passed in as an argument to {@link Resolvers#use(Class)}
* or {@link Resolvers#use(Class, ClassLoader)} to create a new instance.
*
* @param
* View type of the {@link ResolverSystem} which does not support configuration
* @author Andrew Lee Rubinger
*/
public interface ConfigurableResolverSystem> extends ResolverSystem {
/**
* Optional operation. Configures this {@link ConfigurableResolverSystem} from the specified file
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#fromFile(File)} instead.
*
* @param file The file the {@link ConfigurableResolverSystem} should be configured from
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the file is not specified, is a directory, or does not exist
* @throws InvalidConfigurationFileException
* If the configuration file contents are not in appropriate format
* @throws UnsupportedOperationException
* If this {@link ConfigurableResolverSystem} does not support configuration by {@link File}
*/
@Deprecated
CONFIGUREDRESOLVERSYSTEMTYPE configureFromFile(File file) throws IllegalArgumentException,
UnsupportedOperationException, InvalidConfigurationFileException;
/**
* Optional operation. Configures this {@link ConfigurableResolverSystem} from the file at the specified path
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#fromFile(String)} instead.
*
* @param pathToFile Path to the file the {@link ConfigurableResolverSystem} should be configured from
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the file is not specified, is a directory, or does not exist
* @throws InvalidConfigurationFileException
* If the configuration file contents are not in appropriate format
* @throws UnsupportedOperationException
* If this {@link ConfigurableResolverSystem} does not support configuration by {@link File}
* @throws InvalidConfigurationFileException
* If the configuration file contents are not in appropriate format
*/
@Deprecated
CONFIGUREDRESOLVERSYSTEMTYPE configureFromFile(String pathToFile) throws IllegalArgumentException,
UnsupportedOperationException, InvalidConfigurationFileException;
/**
* Optional operation. Configures this {@link ConfigurableResolverSystem} from the result of
* {@link ClassLoader#getResource(String)} using the current {@link Thread#getContextClassLoader()}
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#fromClassloaderResource(String)} instead.
*
* @param path Path to the classloader resource
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the either argument is not specified or if the path can not be found
* @throws UnsupportedOperationException
* If this {@link ConfigurableResolverSystem} does not support configuration by {@link ClassLoader}
* resource
* @throws InvalidConfigurationFileException
* If the configuration file contents are not in appropriate format
*/
@Deprecated
CONFIGUREDRESOLVERSYSTEMTYPE configureFromClassloaderResource(String path) throws IllegalArgumentException,
UnsupportedOperationException, InvalidConfigurationFileException;
/**
* Optional operation. Configures this {@link ConfigurableResolverSystem} from the result of
* {@link ClassLoader#getResource(String)} using the specified {@link ClassLoader}
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#fromClassloaderResource(String, ClassLoader)} instead.
*
* @param path Path to the classloader resource
* @param cl The classloader
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the either argument is not specified or if the path can not be found
* @throws UnsupportedOperationException
* If this {@link ConfigurableResolverSystem} does not support configuration by {@link ClassLoader}
* resource
* @throws InvalidConfigurationFileException
* If the configuration file contents are not in appropriate format
*/
@Deprecated
CONFIGUREDRESOLVERSYSTEMTYPE configureFromClassloaderResource(String path, ClassLoader cl)
throws IllegalArgumentException, UnsupportedOperationException, InvalidConfigurationFileException;
/**
* Configures this {@link ResolverSystem} from the specified file
*
* @param file The file the {@link ResolverSystem} should be configured from
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the file is not specified, is a directory, or does not exist
* @throws InvalidConfigurationFileException
* If the file is not in correct format
*/
CONFIGUREDRESOLVERSYSTEMTYPE fromFile(final File file) throws IllegalArgumentException, InvalidConfigurationFileException;
/**
* Configures this {@link ResolverSystem} from the file at the specified path
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#configureFromFile(String)} instead.
*
* @param pathToFile Path to the file the {@link ResolverSystem} should be configured from
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the file is not specified, is a directory, or does not exist
* @throws InvalidConfigurationFileException
* If the file is not in correct format
*/
CONFIGUREDRESOLVERSYSTEMTYPE fromFile(final String pathToFile) throws IllegalArgumentException,
InvalidConfigurationFileException;
/**
* Configures this {@link ResolverSystem} from the result of {@link ClassLoader#getResource(String)} using the
* current {@link Thread#getContextClassLoader()}
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#configureFromClassloaderResource(String)} instead.
*
* @param path Path to the classloader resource
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the path is not specified or can not be found
* @throws InvalidConfigurationFileException
* If the file is not in correct format
*/
CONFIGUREDRESOLVERSYSTEMTYPE fromClassloaderResource(final String path) throws IllegalArgumentException,
InvalidConfigurationFileException;
/**
* Configures this {@link ResolverSystem} from the result of {@link ClassLoader#getResource(String)} using the
* specified {@link ClassLoader}
*
* This method is deprecated. Please use {#link {@link ConfigurableResolverSystem#configureFromClassloaderResource(String, ClassLoader)} instead.
*
* @param path Path to the classloader resource
* @param loader The classloader
* @return This configured {@link ResolverSystem}
* @throws IllegalArgumentException
* If the either argument is not specified or if the path can not be found
* @throws InvalidConfigurationFileException
* If the file is not in correct format
*/
CONFIGUREDRESOLVERSYSTEMTYPE fromClassloaderResource(final String path, final ClassLoader loader)
throws IllegalArgumentException, InvalidConfigurationFileException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy