public interface

MavenUrlReference

implements UrlReference
org.ops4j.pax.exam.options.MavenUrlReference
Known Indirect Subclasses

Class Overview

Option specifying a maven url (Pax URL mvn: handler).

Summary

Nested Classes
interface MavenUrlReference.VersionResolver Resolves versions based on maven artifact groupId / atifactid. 
Public Methods
abstract MavenUrlReference artifactId(String artifactId)
Sets the artifact id.
abstract MavenUrlReference classifier(String classifier)
Sets the artifact classifier.
abstract MavenUrlReference groupId(String groupId)
Sets the artifact group id.
abstract Boolean isSnapshot()
Returns true if the specified version is a snapshot version, false if not and null if the version is not yet specified.
abstract MavenUrlReference type(String type)
Sets the artifact type.
abstract MavenUrlReference version(MavenUrlReference.VersionResolver resolver)
Determines the artifact version using an MavenUrlReference.VersionResolver.
abstract MavenUrlReference version(String version)
Sets the artifact version or version range.
abstract MavenUrlReference versionAsInProject()
Version will be discovered from the dependencies of Maven project that includes the regression.
[Expand]
Inherited Methods
From interface org.ops4j.pax.exam.options.UrlReference

Public Methods

public abstract MavenUrlReference artifactId (String artifactId)

Sets the artifact id.

Parameters
artifactId artifact id (cannot be null or empty)
Returns
  • itself, for fluent api usage
Throws
IllegalArgumentException - If artifact id is null or empty

public abstract MavenUrlReference classifier (String classifier)

Sets the artifact classifier.

Parameters
classifier artifact classifier (cannot be null or empty)
Returns
  • itself, for fluent api usage
Throws
IllegalArgumentException - If classifier is null or empty

public abstract MavenUrlReference groupId (String groupId)

Sets the artifact group id.

Parameters
groupId artifact group id (cannot be null or empty)
Returns
  • itself, for fluent api usage
Throws
IllegalArgumentException - If group id is null or empty

public abstract Boolean isSnapshot ()

Returns true if the specified version is a snapshot version, false if not and null if the version is not yet specified.

Returns
  • true if the specified version is a snapshot version, false if not and null if the version is not yet specified.

public abstract MavenUrlReference type (String type)

Sets the artifact type. Do not set the value (use this method) if default artifact type should be used.

Parameters
type artifact type (cannot be null or empty)
Returns
  • itself, for fluent api usage
Throws
IllegalArgumentException - If type is null or empty

public abstract MavenUrlReference version (MavenUrlReference.VersionResolver resolver)

Determines the artifact version using an MavenUrlReference.VersionResolver.

Parameters
resolver a MavenUrlReference.VersionResolver (cannot be null)
Returns
  • itself, for fluent api usage
Throws
IllegalArgumentException - If version is null

public abstract MavenUrlReference version (String version)

Sets the artifact version or version range. If version is a SNAPSHOT version the bundle will be set to updatable, otherwise the bundle will not be updated. This handling happens only if the user dows not use the update() by itself (see org.ops4j.pax.exam.options.ProvisionOption#update(boolean)).

Parameters
version artifact version / version range (cannot be null or empty)
Returns
  • itself, for fluent api usage
Throws
IllegalArgumentException - If version is null or empty

public abstract MavenUrlReference versionAsInProject ()

Version will be discovered from the dependencies of Maven project that includes the regression.

Returns
  • itself, for fluent api usage