com.jcabi.aether

Class Classpath

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<File>

com.jcabi.aether.Classpath

All Implemented Interfaces:

Iterable<File>, Collection<File>, Set<File>

@Loggable(value=1,
          limit=1,
          unit=MINUTES,
          trim=false)
public final class Classpath
extends AbstractSet<File>

A classpath of a Maven Project.

It is a convenient wrapper around Aether class, that allows you to fetch all dependencies of a Maven Project by their scope. The class implements a Set of Files and can be used like this:

 String classpath = StringUtils.join(
   new Classpath(project, localRepo, "runtime")
   System.getProperty("path.separator")
 );

Important to notice that this class resolves artifacts from repositories only once per instance. It means that once resolved the list of files is cached and never flushes. In order to resolve again (if you think that content of repositories is changed), make a new instance of the class.

Since:

0.7.16

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Aether

Suppressed Checkstyle violations:

ClassDataAbstractionCoupling (500 lines)

Constructor Summary

Constructors

Constructor and Description
Classpath(MavenProject prj, File repo, Collection<String> scps) Public ctor.
Classpath(MavenProject prj, File repo, String scp) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<File>	iterator()
int	size()
String	toString()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray

Constructor Detail

Classpath

public Classpath(@NotNull
         MavenProject prj,
         @NotNull
         File repo,
         @NotNull
         String scp)

Public ctor.

Parameters:

prj - The Maven project

repo - Local repository location (directory path)

scp - The scope to use, e.g. "runtime" or "compile"

Classpath

public Classpath(@NotNull
         MavenProject prj,
         @NotNull
         File repo,
         @NotNull
         Collection<String> scps)

Public ctor.

Parameters:

prj - The Maven project

repo - Local repository location (directory path)

scps - All scopes to include

Method Detail

toString

public String toString()

Overrides:

toString in class AbstractCollection<File>

iterator

public Iterator<File> iterator()

Specified by:

iterator in interface Iterable<File>

Specified by:

iterator in interface Collection<File>

Specified by:

iterator in interface Set<File>

Specified by:

iterator in class AbstractCollection<File>

size

public int size()

Specified by:

size in interface Collection<File>

Specified by:

size in interface Set<File>

Specified by:

size in class AbstractCollection<File>