org.apache.sling.feature

Class Bundles

java.lang.Object

org.apache.sling.feature.Bundles

All Implemented Interfaces:

Iterable<Artifact>

public class Bundles
extends Object
implements Iterable<Artifact>

Bundles groups a list of bundles Artifact and provides a means to sort them based on start order.

Constructor Summary

Constructors

Constructor and Description
Bundles()

Method Summary

Modifier and Type	Method and Description
void	add(Artifact bundle) Add an artifact as a bundle.
void	clear() Clear the bundles list.
boolean	containsExact(ArtifactId id) Checks whether the exact artifact is available
boolean	containsSame(ArtifactId id) Checks whether the same artifact is available, neglecting the version
Map<Integer,List<Artifact>>	getBundlesByStartOrder() Get the map of all bundles sorted by start order.
Artifact	getSame(ArtifactId id) Get the artifact for the given id, neglecting the version
boolean	isEmpty() Check whether this container has bundles
Iterator<Artifact>	iterator() Iterate over all bundles
boolean	removeExact(ArtifactId id) Remove the exact artifact.
boolean	removeSame(ArtifactId id) Remove the same artifact, neglecting the version.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Bundles

public Bundles()

Method Detail

getBundlesByStartOrder

public Map<Integer,List<Artifact>> getBundlesByStartOrder()

Get the map of all bundles sorted by start order. The map is sorted and iterating over the keys is done in start order. Bundles without a start order (having the value 0) are returned last.

Returns:

The map of bundles. The map is unmodifiable.

add

public void add(Artifact bundle)

Add an artifact as a bundle.

Parameters:

bundle - The bundle

removeExact

public boolean removeExact(ArtifactId id)

Remove the exact artifact. All start orders are searched for such an artifact. The first one found is removed.

Parameters:

id - The artifact id

Returns:

true if the artifact has been removed

removeSame

public boolean removeSame(ArtifactId id)

Remove the same artifact, neglecting the version. All start orders are searched for such an artifact. The first one found is removed.

Parameters:

id - The artifact id

Returns:

true if the artifact has been removed

clear

public void clear()

Clear the bundles list.

getSame

public Artifact getSame(ArtifactId id)

Get the artifact for the given id, neglecting the version

Parameters:

id - The artifact id

Returns:

A map entry with start order and artifact, null otherwise

containsExact

public boolean containsExact(ArtifactId id)

Checks whether the exact artifact is available

Parameters:

id - The artifact id.

Returns:

true if the artifact exists

containsSame

public boolean containsSame(ArtifactId id)

Checks whether the same artifact is available, neglecting the version

Parameters:

id - The artifact id.

Returns:

true if the artifact exists

iterator

public Iterator<Artifact> iterator()

Iterate over all bundles

Specified by:

iterator in interface Iterable<Artifact>

isEmpty

public boolean isEmpty()

Check whether this container has bundles

Returns:

true if there are no bundles.

toString

public String toString()

Overrides:

toString in class Object