ShrinkWrap Resolver API 2.0.0-cr-1

org.jboss.shrinkwrap.resolver.api
Interface ResolveStage<COORDINATETYPE extends Coordinate,RESOLUTIONFILTERTYPE extends ResolutionFilter,RESOLVESTAGETYPE extends ResolveStage<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLVESTAGETYPE,STRATEGYSTAGETYPE,RESOLVEDTYPE,FORMATSTAGETYPE,RESOLUTIONSTRATEGYTYPE>,STRATEGYSTAGETYPE extends StrategyStage<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLVEDTYPE,FORMATSTAGETYPE,RESOLUTIONSTRATEGYTYPE>,RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>,FORMATSTAGETYPE extends FormatStage<RESOLVEDTYPE>,RESOLUTIONSTRATEGYTYPE extends ResolutionStrategy<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLUTIONSTRATEGYTYPE>>


public interface ResolveStage<COORDINATETYPE extends Coordinate,RESOLUTIONFILTERTYPE extends ResolutionFilter,RESOLVESTAGETYPE extends ResolveStage<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLVESTAGETYPE,STRATEGYSTAGETYPE,RESOLVEDTYPE,FORMATSTAGETYPE,RESOLUTIONSTRATEGYTYPE>,STRATEGYSTAGETYPE extends StrategyStage<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLVEDTYPE,FORMATSTAGETYPE,RESOLUTIONSTRATEGYTYPE>,RESOLVEDTYPE extends ResolvedArtifact<RESOLVEDTYPE>,FORMATSTAGETYPE extends FormatStage<RESOLVEDTYPE>,RESOLUTIONSTRATEGYTYPE extends ResolutionStrategy<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLUTIONSTRATEGYTYPE>>

Represents the stage in resolution in which the user supplies (a) Coordinate address(es) for resolution in a repository-based ResolverSystem.

Author:
Andrew Lee Rubinger, Karel Piwko

Method Summary
 RESOLVESTAGETYPE addDependencies(Collection<COORDINATETYPE> dependencies)
          Adds the specified dependencies to be resolved
 RESOLVESTAGETYPE addDependencies(COORDINATETYPE... dependencies)
          Adds the specified coordinates to be resolved
 RESOLVESTAGETYPE addDependency(COORDINATETYPE dependency)
          Adds the specified coordinate to be resolved
 STRATEGYSTAGETYPE resolve()
          Begins resolution of the prior-defined dependencies, returning the next StrategyStage for the user to define the ResolutionStrategy
 STRATEGYSTAGETYPE resolve(Collection<String> canonicalForms)
          Begins resolution by defining a Collection of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
 STRATEGYSTAGETYPE resolve(String... canonicalForms)
          Begins resolution by defining a set of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
 STRATEGYSTAGETYPE resolve(String canonicalForm)
          Begins resolution by defining the single desired dependency (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy.
 

Method Detail

resolve

STRATEGYSTAGETYPE resolve()
                                                                                                                                         throws IllegalStateException,
                                                                                                                                                ResolutionException
Begins resolution of the prior-defined dependencies, returning the next StrategyStage for the user to define the ResolutionStrategy

Returns:
Throws:
IllegalStateException - If no dependencies have yet been added
ResolutionException - If an error occured in resolution

resolve

STRATEGYSTAGETYPE resolve(String canonicalForm)
                                                                                                                                         throws IllegalArgumentException,
                                                                                                                                                ResolutionException,
                                                                                                                                                CoordinateParseException
Begins resolution by defining the single desired dependency (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Parameters:
canonicalForm -
Returns:
Throws:
IllegalArgumentException - If no coordinate is supplied
ResolutionException - If an error occurred in resolution
CoordinateParseException - If the specified canonical form is invalid

resolve

STRATEGYSTAGETYPE resolve(String... canonicalForms)
                                                                                                                                         throws IllegalArgumentException,
                                                                                                                                                ResolutionException,
                                                                                                                                                CoordinateParseException
Begins resolution by defining a set of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Parameters:
canonicalForms -
Returns:
Throws:
IllegalArgumentException - If no coordinates are supplied
ResolutionException - If an error occurred in resolution
CoordinateParseException - If one or more of the specified canonical forms is invalid

resolve

STRATEGYSTAGETYPE resolve(Collection<String> canonicalForms)
                                                                                                                                         throws IllegalArgumentException,
                                                                                                                                                ResolutionException,
                                                                                                                                                CoordinateParseException
Begins resolution by defining a Collection of desired dependencies (in canonical form), returning the next StrategyStage for the user to define the ResolutionStrategy. Previously-added dependencies will be included in resolution.

Parameters:
canonicalForms -
Returns:
Throws:
IllegalArgumentException - If no coordinates are supplied
ResolutionException - If an error occurred in resolution
CoordinateParseException - If one or more of the specified canonical forms is invalid

addDependency

RESOLVESTAGETYPE addDependency(COORDINATETYPE dependency)
                                                                                                                                                                                throws IllegalArgumentException
Adds the specified coordinate to be resolved

Returns:
Throws:
IllegalArgumentException - If no dependency is supplied

addDependencies

RESOLVESTAGETYPE addDependencies(COORDINATETYPE... dependencies)
                                                                                                                                                                                  throws IllegalArgumentException
Adds the specified coordinates to be resolved

Returns:
Throws:
IllegalArgumentException - If no dependencies are supplied

addDependencies

RESOLVESTAGETYPE addDependencies(Collection<COORDINATETYPE> dependencies)
                                                                                                                                                                                  throws IllegalArgumentException
Adds the specified dependencies to be resolved

Returns:
Throws:
IllegalArgumentException - If the Collection is null

ShrinkWrap Resolver API 2.0.0-cr-1

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.