ShrinkWrap Resolver Maven API 2.0.0-alpha-2
A C E F G H I L M O P R S T V W

A

as(Class<ResolvedArtifactInfo>) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenFormatStage
Formats the resultant artifacts as an array of ResolvedArtifactInfos.
asSingle(Class<ResolvedArtifactInfo>) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenFormatStage
Formats the resultant artifact as a ResolvedArtifactInfo; assumes a single artifact is returned from resolution.

C

ConfigurableMavenResolverSystem - Interface in org.jboss.shrinkwrap.resolver.api.maven
Entry point of a Maven-based Resolver system which supports configuration.
ConfigurableMavenResolverSystemBase<UNCONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,CONFIGURABLERESOLVERSYSTEMTYPE extends MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage> - Interface in org.jboss.shrinkwrap.resolver.api.maven
Entry point of a Maven-based Resolver system which supports configuration.
configureResolver() - Static method in class org.jboss.shrinkwrap.resolver.api.maven.Maven
Creates and returns a new ConfiguredResolverSystemFactory instance which may be used to create new MavenResolverSystem instances
configureResolverViaPlugin() - Static method in class org.jboss.shrinkwrap.resolver.api.maven.Maven
Configures the MavenResolverSystem with settings.xml and POM metadata as picked up from the environment (these properties are set by the ShrinkWrap Maven Resolver Plugin).
configureResolverViaPlugin(ClassLoader) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.Maven
Configures the MavenResolverSystem with settings.xml and POM metadata as picked up from the environment (these properties are set by the ShrinkWrap Maven Resolver Plugin).
configureViaPlugin() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ConfigurableMavenResolverSystemBase
Configures the current session from POM metadata found via the ShrinkWrap Resolver Maven Plugin; retrieves information from the currently-running Maven process.
createCoordinate(String) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinates
Creates a new MavenCoordinate instance from the specified, required canonical form in format :[:[:]][:]
createCoordinate(String, String, String, PackagingType, String) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinates
Creates a new MavenCoordinate instance from the specified arguments
createDependency(String, ScopeType, boolean, MavenDependencyExclusion...) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependencies
Creates a new MavenDependency instance from the specified, required canonical form in format :[:[:]][:], with the additional, optional properties.
createDependency(MavenCoordinate, ScopeType, boolean, MavenDependencyExclusion...) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependencies
Creates a new MavenDependency instance from the specified properties.
createExclusion(String) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependencies
Creates a new MavenDependencyExclusion instance from the specified, required canonical form in format :
createExclusion(String, String) - Static method in class org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependencies
Creates a new MavenDependencyExclusion instance from the specified, required arguments

E

equals(Object) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinate
Determines whether two MavenCoordinate instances are equal by value; all fields are considered exception for version

F

fromPackagingType(String) - Static method in enum org.jboss.shrinkwrap.resolver.api.maven.PackagingType
Maps a string to PackagingType
fromScopeType(String) - Static method in enum org.jboss.shrinkwrap.resolver.api.maven.ScopeType
Maps a string to ScopeType

G

getArtifact(FORMATTERTYPE) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns the resolved artifact using the specified FORMATTERTYPE instance
getArtifact(Class<File>) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns the resolved artifact as a File; alias for ResolvedArtifactInfo.getArtifact(FormatProcessor) passing in argument of FileFormatProcessor
getArtifact(Class<InputStream>) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns the resolved artifact as an InputStream; alias for ResolvedArtifactInfo.getArtifact(FormatProcessor) passing in argument of InputStreamFormatProcessor
getClassifier() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinate
Returns the "classifier" portion of this artifact's coordinates.
getCoordinate() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns the defined coordinate (ie.
getExclusions() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependency
Returns the exclusions defined for this MavenDependency in an immutable, read-only view.
getExtension() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns the file extension of this artifact, ie.
getPackaging() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinate
Returns the "packaging" portion of this artifact's coordinates; always returns a value.
getPostResolutionFilter() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenResolutionStrategy
Obtains the ResolutionFilter to be used in filtering the MavenDependency List returned from the backend response.
getPreResolutionFilter() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenResolutionStrategy
Obtains the ResolutionFilter to be used in filtering the MavenDependency List before the request is executed.
getResolutionFilter() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenResolutionStrategy
Obtains the ResolutionFilter to be used in filtering the MavenDependency List during request processing (filtering is done by the backend).
getResolvedVersion() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns the resolved "version" portion of this artifact's coordinates; SNAPSHOTs may declare a version field (as represented by VersionedMavenCoordinate#getVersion(), which must resolve to a versioned snapshot version number.
getScope() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependency
Returns the scope for this MavenDependency.
getType() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinate
Alias to getPackaging().
getVersion() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinate
Returns the declared "version" portion of this artifact's coordinates, for instance "1.2.0-alpha-2" or "1.2.0-SNAPSHOT".

H

hashCode() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenCoordinate

I

importRuntimeAndTestDependencies() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomEquippedResolveStageBase
Resolves dependencies in all scopes as defined by the POM metadata.
importRuntimeAndTestDependencies(MavenResolutionStrategy) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomEquippedResolveStageBase
Resolves dependencies in all scopes as defined by the POM metadata, using the additional ResolutionStrategy.
importRuntimeDependencies() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomEquippedResolveStageBase
Resolves all runtime dependencies defined by the POM metadata.
importRuntimeDependencies(MavenResolutionStrategy) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomEquippedResolveStageBase
Resolves all dependencies defined by the POM metadata, using the additional ResolutionStrategy.
InvalidEnvironmentException - Exception in org.jboss.shrinkwrap.resolver.api.maven
Indicates that the current environment does not support PomlessResolveStageBase#loadPomViaPlugin() ; likely this option has been selected while running outside the control of the ShrinkWrap Resolver Maven Plugin.
InvalidEnvironmentException(String) - Constructor for exception org.jboss.shrinkwrap.resolver.api.maven.InvalidEnvironmentException
Creates a new instance
isOptional() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependency
Returns whether or not this MavenDependency has been marked as optional; defaults to false
isSnapshotVersion() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.ResolvedArtifactInfo
Returns whether or not this artifact is using a SNAPSHOT version.

L

loadPomFromClassLoaderResource(String) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the current Thread.getContextClassLoader().
loadPomFromClassLoaderResource(String, ClassLoader) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
loadPomFromClassLoaderResource(String, ClassLoader, String...) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified ClassLoader resource path, loaded by the specified ClassLoader.
loadPomFromFile(File) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.
loadPomFromFile(File, String...) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the specified POM File.
loadPomFromFile(String) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path.
loadPomFromFile(String, String...) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.PomlessResolveStageBase
Configures the Maven Resolver System Project Object Model from metadata contained in the POM file located at the specified path.

M

Maven - Class in org.jboss.shrinkwrap.resolver.api.maven
Shorthand convenience API where the call Maven.resolver() is analogous to a more longhand, formal call to Resolvers.use(Class), passing MavenResolverSystem as the argument.
Maven() - Constructor for class org.jboss.shrinkwrap.resolver.api.maven.Maven
 
MavenCoordinate - Interface in org.jboss.shrinkwrap.resolver.api.maven.coordinate
Represents a single Maven coordinate (an address in canonical form "groupId:artifactId:packaging:classifier:version") which is capable of resolving to an artifact.
MavenCoordinates - Class in org.jboss.shrinkwrap.resolver.api.maven.coordinate
Factory class for creating new MavenCoordinate instances
MavenDependencies - Class in org.jboss.shrinkwrap.resolver.api.maven.coordinate
Factory class for creating new MavenDependency instances
MavenDependency - Interface in org.jboss.shrinkwrap.resolver.api.maven.coordinate
Metadata describing a declaration; immutable and Thread-safe.
MavenDependencyExclusion - Interface in org.jboss.shrinkwrap.resolver.api.maven.coordinate
Defines a single element for a MavenDependency.
MavenFormatStage - Interface in org.jboss.shrinkwrap.resolver.api.maven
Represents the formatting stage of Maven-based resolution in which the resolved artifact is returned in the desired format.
MavenResolutionFilter - Interface in org.jboss.shrinkwrap.resolver.api.maven
Determines whether a Maven MavenDependency is to be honored
MavenResolutionStrategy - Interface in org.jboss.shrinkwrap.resolver.api.maven
Defines the contract for developing a Maven-based ResolutionStrategy; this is composed by assembling Lists of type RESOLUTIONFILTERTYPE for filtering MavenDependencys before, during and after the resolution request is executed.
MavenResolverSystem - Interface in org.jboss.shrinkwrap.resolver.api.maven
Entry point of a Maven-based Resolver system which does not suppport configuration.
MavenResolverSystemBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage> - Interface in org.jboss.shrinkwrap.resolver.api.maven
Entry point of a Maven-based Resolver system which does not suppport configuration.
MavenResolveStageBase<RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage> - Interface in org.jboss.shrinkwrap.resolver.api.maven
 
MavenStrategyStage - Interface in org.jboss.shrinkwrap.resolver.api.maven
Concrete end-user view of a Maven-based StrategyStage in artifact resolution
MavenStrategyStageBase<STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage> - Interface in org.jboss.shrinkwrap.resolver.api.maven
Provides support for Maven-based ResolutionStrategys in artifact resolution

O

offline(boolean) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenStrategyStageBase
Sets whether resolution should be done in "offline" (ie.
offline() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenStrategyStageBase
Sets that resolution should be done in "offline" (ie.
org.jboss.shrinkwrap.resolver.api.maven - package org.jboss.shrinkwrap.resolver.api.maven
 
org.jboss.shrinkwrap.resolver.api.maven.coordinate - package org.jboss.shrinkwrap.resolver.api.maven.coordinate
 

P

PackagingType - Enum in org.jboss.shrinkwrap.resolver.api.maven
Represents the valid values for the "packaging" portion of a MavenCoordinate
PomEquippedResolveStage - Interface in org.jboss.shrinkwrap.resolver.api.maven
Maven-based Resolve Stage which has been loaded with POM metadata
PomEquippedResolveStageBase<RESOLVESTAGETYPE extends MavenResolveStageBase<RESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage> - Interface in org.jboss.shrinkwrap.resolver.api.maven
Defines the contract for operations denoting a ResolverStage has been configured via POM (Project Object Model) metadata
PomlessResolveStage - Interface in org.jboss.shrinkwrap.resolver.api.maven
Maven-based Resolve Stage which may be loaded with POM metadata
PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE extends PomEquippedResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,UNEQUIPPEDRESOLVESTAGETYPE extends PomlessResolveStageBase<EQUIPPEDRESOLVESTAGETYPE,UNEQUIPPEDRESOLVESTAGETYPE,STRATEGYSTAGETYPE,FORMATSTAGETYPE>,STRATEGYSTAGETYPE extends MavenStrategyStageBase<STRATEGYSTAGETYPE,FORMATSTAGETYPE>,FORMATSTAGETYPE extends MavenFormatStage> - Interface in org.jboss.shrinkwrap.resolver.api.maven
Defines the contract for operations denoting a ResolveStage is able to load POM (Project Object Model) metadata

R

ResolvedArtifactInfo - Interface in org.jboss.shrinkwrap.resolver.api.maven
Encapsulation of a resolved Maven-based artifact's metadata
resolver() - Static method in class org.jboss.shrinkwrap.resolver.api.maven.Maven
Creates and returns a new MavenResolverSystem instance

S

ScopeType - Enum in org.jboss.shrinkwrap.resolver.api.maven
Valid scope types for Maven MavenDependency metadata

T

toCanonicalForm() - Method in interface org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependencyExclusion
Returns the canonical form of this MavenDependencyExclusion in format groupId:artifactId
toString() - Method in enum org.jboss.shrinkwrap.resolver.api.maven.PackagingType
Returns the canonical String value of this PackagingType
toString() - Method in enum org.jboss.shrinkwrap.resolver.api.maven.ScopeType
Returns the ScopeType.value of this enum

V

valueOf(String) - Static method in enum org.jboss.shrinkwrap.resolver.api.maven.PackagingType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.shrinkwrap.resolver.api.maven.ScopeType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jboss.shrinkwrap.resolver.api.maven.PackagingType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.shrinkwrap.resolver.api.maven.ScopeType
Returns an array containing the constants of this enum type, in the order they are declared.

W

withClassPathResolution(boolean) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenStrategyStageBase
Sets that resolution from the ClassPath should be permitted in addition to configured repositories - defaults to "true"
withMavenCentralRepo(boolean) - Method in interface org.jboss.shrinkwrap.resolver.api.maven.MavenStrategyStageBase
Sets whether to consult the Maven Central Repository in resolution; defaults to true.

A C E F G H I L M O P R S T V W
ShrinkWrap Resolver Maven API 2.0.0-alpha-2

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