com.threecrickets.sincerity.dependencies

Class Modules<M extends Module>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<M>

com.threecrickets.sincerity.dependencies.Modules<M>

Type Parameters:

M - The module class

All Implemented Interfaces:

Iterable<M>, Collection<M>, List<M>

Direct Known Subclasses:

IvyModules

public abstract class Modules<M extends Module>
extends AbstractList<M>

A tree of all modules actually installed by a Dependencies instance, with added utility methods for querying different aspects of this data. See Dependencies.getModules().

The instance itself is a list of the root nodes of the tree (the explicit dependencies). For flat access to the entire tree, use getAll().

Author:

Tal Liron

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Modules()

Method Summary

Modifier and Type	Method and Description
abstract Collection<M>	getAll() Cached list of all modules, whether explicit or implicit.
abstract Collection<Artifact>	getArtifacts() Tje artifacts.
abstract Collection<M>	getByLicense(License license) All modules using a license.
abstract Collection<License>	getLicenses() The licenses.
abstract String	getVersion(String group, String name) The version of a module.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Modules

public Modules()

Method Detail

getAll

public abstract Collection<M> getAll()

Cached list of all modules, whether explicit or implicit.

Returns:

The modules

getArtifacts

public abstract Collection<Artifact> getArtifacts()

Tje artifacts.

Returns:

The artifacts

getLicenses

public abstract Collection<License> getLicenses()

The licenses.

Returns:

The licenses

getByLicense

public abstract Collection<M> getByLicense(License license)

All modules using a license.

Parameters:

license - The license

Returns:

The modules

getVersion

public abstract String getVersion(String group,
                                  String name)
                           throws SincerityException

The version of a module.

Parameters:

group - The module's group

name - The module's name

Returns:

The module's version or null

Throws:

SincerityException - In case of an error