ShrinkWrap Resolver API 2.0.0-alpha-3

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


public interface ResolveStage<COORDINATETYPE extends Coordinate,RESOLUTIONFILTERTYPE extends ResolutionFilter,RESOLVESTAGETYPE extends ResolveStage<COORDINATETYPE,RESOLUTIONFILTERTYPE,RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE,RESOLUTIONSTRATEGYTYPE>,STRATEGYSTAGETYPE extends StrategyStage<COORDINATETYPE,RESOLUTIONFILTERTYPE,FORMATSTAGETYPE,RESOLUTIONSTRATEGYTYPE>,FORMATSTAGETYPE extends FormatStage,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(COORDINATETYPE... coordinates)
          Adds the specified coordinates to be resolved
 RESOLVESTAGETYPE addDependencies(String... coordinate)
          Adds the specified coordinates, initially parsed from the specified canonical forms, to be resolved
 RESOLVESTAGETYPE addDependency(COORDINATETYPE coordinate)
          Adds the specified coordinate to be resolved
 RESOLVESTAGETYPE addDependency(String coordinate)
          Adds the specified coordinate, initially parsed from the specified canonical form, to be resolved
 STRATEGYSTAGETYPE resolve()
          Begins resolution of the prior-defined coordinate(s), returning the next StrategyStage for the user to define the ResolutionStrategy
 STRATEGYSTAGETYPE resolve(COORDINATETYPE... coordinates)
          Begins resolution by defining a set of desired coordinates, returning the next StrategyStage for the user to define the ResolutionStrategy
 STRATEGYSTAGETYPE resolve(COORDINATETYPE coordinate)
          Begins resolution by defining the single desired coordinate, returning the next StrategyStage for the user to define the ResolutionStrategy
 STRATEGYSTAGETYPE resolve(String... coordinates)
          Begins resolution by defining a set of desired coordinates, returning the next StrategyStage for the user to define the ResolutionStrategy
 STRATEGYSTAGETYPE resolve(String coordinate)
          Begins resolution by defining the single desired coordinate, 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 coordinate(s), 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 coordinate)
                                                                                                                            throws IllegalArgumentException,
                                                                                                                                   ResolutionException
Begins resolution by defining the single desired coordinate, returning the next StrategyStage for the user to define the ResolutionStrategy

Parameters:
coordinate -
Returns:
Throws:
IllegalArgumentException - If no coordinate is supplied
ResolutionException - If an error occured in resolution

resolve

STRATEGYSTAGETYPE resolve(String... coordinates)
                                                                                                                            throws IllegalArgumentException,
                                                                                                                                   ResolutionException
Begins resolution by defining a set of desired coordinates, returning the next StrategyStage for the user to define the ResolutionStrategy

Parameters:
coordinate -
Returns:
Throws:
IllegalArgumentException - If no coordinates are supplied
ResolutionException - If an error occured in resolution

resolve

STRATEGYSTAGETYPE resolve(COORDINATETYPE coordinate)
                                                                                                                            throws IllegalArgumentException,
                                                                                                                                   ResolutionException
Begins resolution by defining the single desired coordinate, returning the next StrategyStage for the user to define the ResolutionStrategy

Parameters:
coordinate -
Returns:
Throws:
IllegalArgumentException - If no coordinate is supplied
ResolutionException - If an error occured in resolution

resolve

STRATEGYSTAGETYPE resolve(COORDINATETYPE... coordinates)
                                                                                                                            throws IllegalArgumentException,
                                                                                                                                   ResolutionException
Begins resolution by defining a set of desired coordinates, returning the next StrategyStage for the user to define the ResolutionStrategy

Parameters:
coordinate -
Returns:
Throws:
IllegalArgumentException - If no coordinates are supplied
ResolutionException - If an error occured in resolution

addDependency

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

Returns:
Throws:
IllegalArgumentException - If no coordinate is supplied

addDependency

RESOLVESTAGETYPE addDependency(String coordinate)
                                                                                                                                                                   throws CoordinateParseException,
                                                                                                                                                                          IllegalArgumentException
Adds the specified coordinate, initially parsed from the specified canonical form, to be resolved

Returns:
Throws:
IllegalArgumentException - If no coordinate is supplied
CoordinateParseException - If the dependency could not be parsed

addDependencies

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

Returns:
Throws:
IllegalArgumentException - If no coordinates are supplied

addDependencies

RESOLVESTAGETYPE addDependencies(String... coordinate)
                                                                                                                                                                     throws CoordinateParseException,
                                                                                                                                                                            IllegalArgumentException
Adds the specified coordinates, initially parsed from the specified canonical forms, to be resolved

Returns:
Throws:
IllegalArgumentException - If no coordinates are supplied
CoordinateParseException

ShrinkWrap Resolver API 2.0.0-alpha-3

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