Package org.eclipse.aether.scope

Interface SystemDependencyScope

All Superinterfaces:

DependencyScope

public interface SystemDependencyScope
extends DependencyScope

A special dependency scope: "system".

This is a special scope. In this scope case, Resolver should handle dependencies specially, as they have no POM (so are always a leaf on graph), are not in any repository, but are actually hosted on host OS file system. On resolution resolver merely checks is file present or not.

Since:

2.0.0

Restriction:

This interface is not intended to be extended by clients.

Restriction:

This interface is not intended to be implemented by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemDependencyScope	LEGACY	The "legacy" system scope, used when there is no ScopeManager set on session.

Method Summary

Modifier and Type	Method	Description
String	getSystemPath(Artifact artifact)	Returns system path string of provided artifact, or null.
void	setSystemPath(Map<String,String> properties, String systemPath)	Sets system path in properties.

Methods inherited from interface org.eclipse.aether.scope.DependencyScope

getId, is, isTransitive

Field Details

LEGACY

static final SystemDependencyScope LEGACY

The "legacy" system scope, used when there is no ScopeManager set on session.

Method Details

getSystemPath

String getSystemPath(Artifact artifact)

Returns system path string of provided artifact, or null.

Parameters:

artifact - The artifact that we want system path from, must not be null.

Returns:

the system path from passed in properties, or null if not present.

setSystemPath

void setSystemPath(Map<String,String> properties,
 String systemPath)

Sets system path in properties. The passed in systemPath can be null, in which case expected operation is "remove" (or "unset").

Parameters:

properties - the properties map, must not be null.

systemPath - the system path to set (if not null) or unset (if null).