API cleanup

1 files changed, 25 insertions, 14 deletions

diff --git a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
index 1bfada5b9..ed9abff1d 100644
--- a/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
+++ b/bundles/org.eclipse.equinox.p2.repository/src/org/eclipse/equinox/p2/repository/ICompositeRepository.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- *  Copyright (c) 2008, 2009 IBM Corporation and others.
+ *  Copyright (c) 2008, 2010 IBM Corporation and others.
  *  All rights reserved. This program and the accompanying materials
  *  are made available under the terms of the Eclipse Public License v1.0
  *  which accompanies this distribution, and is available at
@@ -12,33 +12,44 @@ package org.eclipse.equinox.p2.repository;
 
 import java.net.URI;
 import java.util.List;
+import org.eclipse.equinox.p2.metadata.IArtifactKey;
+import org.eclipse.equinox.p2.metadata.IInstallableUnit;
 
 /**
+ * A composite repository doesn't directly contain any contents, but rather contains
+ * only a list of child repositories. The composite repository aggregates content
+ * from the children and acts as a single repository containing the union of all
+ * child contents. When a composite repository is queried programmatically,
+ * it will appear to contain all elements that currently exist in one or more
+ * of its children. 
+ * @param <T> The type of repository content. Typically this is either {@link IInstallableUnit}
+ * or {@link IArtifactKey}.
  * @since 2.0
  */
 public interface ICompositeRepository<T> extends IRepository<T> {
 	/**
-	 * 
-	 * @return a list of URIs containing the locations of the children repositories
+	 * Adds a specified URI to list of child repositories.
+	 * Does nothing if URI is a duplicate of an existing child repository.
+	 * @param child
 	 */
-	public abstract List<URI> getChildren();
+	public void addChild(URI child);
 
 	/**
-	 * Removes all child repositories
+	 * Returns a list of URIs containing the locations of the children repositories
+	 * 
+	 * @return a list of URIs containing the locations of the children repositories
 	 */
-	public abstract void removeAllChildren();
+	public List<URI> getChildren();
 
 	/**
-	 * Removes specified URI from list of child repositories.
-	 * Does nothing if specified URI is not a child repository
-	 * @param child
+	 * Removes all child repositories
 	 */
-	public abstract void removeChild(URI child);
+	public void removeAllChildren();
 
 	/**
-	 * Adds a specified URI to list of child repositories.
-	 * Does nothing if URI is a duplicate of an existing child repository.
-	 * @param child
+	 * Removes the specified URI from the list of child repositories.
+	 * This method has no effect if the specified URI is not a child repository
+	 * @param child The child to remove
 	 */
-	public abstract void addChild(URI child);
+	public void removeChild(URI child);
 }