From 7ccc1de5fb33cf1a1064a0a72d81f3e0e2383395 Mon Sep 17 00:00:00 2001
From: John Ross
Date: Wed, 19 Sep 2012 06:28:26 -0500
Subject: Started javadoc for ResolutionReport.Entry.Type.

---
 .../osgi/report/resolution/ResolutionReport.java   | 35 +++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/report/resolution/ResolutionReport.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/report/resolution/ResolutionReport.java
index 00eba791f..f79adbcae 100644
--- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/report/resolution/ResolutionReport.java
+++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/report/resolution/ResolutionReport.java
@@ -20,9 +20,42 @@ import org.osgi.resource.Resource;
 public interface ResolutionReport {
 	public interface Entry {
 		enum Type {
-			FILTERED_BY_RESOLVER_HOOK, MISSING_CAPABILITY, SINGLETON_SELECTION, UNRESOLVED_PROVIDER
+			/**
+			 * Indicates a resource failed to resolve because a resolver hook
+			 * filtered it out. The structure of the data is <code>null</code>.
+			 */
+			// TODO This could possibly be improved by adding a reference to the
+			// hook that filtered it out.
+			FILTERED_BY_RESOLVER_HOOK,
+			/**
+			 * Indicates a resource failed to resolve because no capabilities
+			 * matching one of the resource's requirements could not be found.
+			 * The structure of the data is <code>Capability</code>, which
+			 * represents the missing capability.
+			 */
+			// TODO The data structure should include the requirement as well.
+			MISSING_CAPABILITY,
+			/**
+			 * Indicates a resource failed to resolve because (1) it's a
+			 * singleton, (2) there was at least one collision, and (3) it was
+			 * not the selected singleton. The structure of the data is <code>
+			 * Resource</code>, which represents the singleton with which the
+			 * resource collided.
+			 */
+			// TODO Should the data present all of the colliding singletons
+			// rather than multiple entries each containing a single collision?
+			SINGLETON_SELECTION,
+			/**
+			 * Indicates a resource failed to resolve because one or more
+			 * providers of capabilities matching the resource's requirements
+			 * were not resolved. The structure of the data is <code>
+			 * Map&lt;Requirement, Set&lt;Capability&gt;&gt;</code>.
+			 */
+			UNRESOLVED_PROVIDER
 		}
 
+		// TODO Can this make use of generics? Or should this be Map<String, Object>
+		// and each enum would define the key constants?
 		Object getData();
 
 		Type getType();
-- 
cgit v1.2.3