org.jboss.shrinkwrap.resolver.api.maven.coordinate

Class MavenDependencies

java.lang.Object

org.jboss.shrinkwrap.resolver.api.maven.coordinate.MavenDependencies

public final class MavenDependencies
extends Object

Factory class for creating new MavenDependency instances

Author:

Andrew Lee Rubinger

Method Summary

Methods

Modifier and Type	Method and Description
static MavenDependency	createDependency(MavenCoordinate coordinate, ScopeType scope, boolean optional, MavenDependencyExclusion... exclusions) Creates a new MavenDependency instance from the specified properties.
static MavenDependency	createDependency(String canonicalForm, ScopeType scope, boolean optional, MavenDependencyExclusion... exclusions) Creates a new MavenDependency instance from the specified, required canonical form in format <groupId>:<artifactId>[:<packagingType>[:<classifier>]][:<version>], with the additional, optional properties.
static MavenDependencyExclusion	createExclusion(String canonicalForm) Creates a new MavenDependencyExclusion instance from the specified, required canonical form in format <groupId>:<artifactId>
static MavenDependencyExclusion	createExclusion(String groupId, String artifactId) Creates a new MavenDependencyExclusion instance from the specified, required arguments

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createDependency

public static MavenDependency createDependency(String canonicalForm,
                               ScopeType scope,
                               boolean optional,
                               MavenDependencyExclusion... exclusions)
                                        throws IllegalArgumentException,
                                               CoordinateParseException

Creates a new MavenDependency instance from the specified, required canonical form in format <groupId>:<artifactId>[:<packagingType>[:<classifier>]][:<version>], with the additional, optional properties. If no ScopeType is specified, default will be ScopeType.COMPILE.

Parameters:

canonicalForm - A canonical form in format <groupId>:<artifactId>[:<packagingType>[:<classifier>]][:<version>] of the new MavenDependency instance.

scope - A scope of the new MavenDependency instance. Default will be ScopeType.COMPILE.

optional - Whether or not this MavenDependency has been marked as optional; defaults to false.

exclusions - Exclusions of the new MavenDependency instance.

Returns:

The new MavenDependency instance.

Throws:

IllegalArgumentException - If the canonical form is not supplied

CoordinateParseException - If the specified canonical form is not valid

createDependency

public static MavenDependency createDependency(MavenCoordinate coordinate,
                               ScopeType scope,
                               boolean optional,
                               MavenDependencyExclusion... exclusions)
                                        throws IllegalArgumentException,
                                               CoordinateParseException

Creates a new MavenDependency instance from the specified properties. If no ScopeType is specified, default will be ScopeType.COMPILE.

Parameters:

coordinate - A coordinate of the new MavenDependency instance.

scope - A scope of the new MavenDependency instance. Default will be ScopeType.COMPILE.

optional - Whether or not this MavenDependency has been marked as optional; defaults to false.

exclusions - Exclusions of the new MavenDependency instance.

Returns:

The new MavenDependency instance.

Throws:

IllegalArgumentException - If the coordinate is not supplied

CoordinateParseException - If the specified canonical form is not valid

createExclusion

public static MavenDependencyExclusion createExclusion(String canonicalForm)
                                                throws IllegalArgumentException,
                                                       CoordinateParseException

Creates a new MavenDependencyExclusion instance from the specified, required canonical form in format <groupId>:<artifactId>

Parameters:

canonicalForm - A canonical form in format <groupId>:<artifactId>

Returns:

The new MavenDependencyExclusion instance.

Throws:

IllegalArgumentException - If the canonical form is not supplied

CoordinateParseException - If the canonical form is not in the correct format

createExclusion

public static MavenDependencyExclusion createExclusion(String groupId,
                                       String artifactId)
                                                throws IllegalArgumentException

Creates a new MavenDependencyExclusion instance from the specified, required arguments

Parameters:

groupId - A groupId of the new MavenDependencyExclusion instance.

artifactId - An artifactId of the new MavenDependencyExclusion instance.

Returns:

The new MavenDependencyExclusion instance.

Throws:

IllegalArgumentException - If either argument is not specified