svn commit: r1158276 - /maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/creator/OSGIArtifactIndexCreator.java

[ol...@apache.org]

Author: olamy
Date: Tue Aug 16 13:55:29 2011
New Revision: 1158276

URL: http://svn.apache.org/viewvc?rev=1158276&view=rev
Log:
add some javadoc and a more human readable toString

Modified:
    maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/creator/OSGIArtifactIndexCreator.java

Modified: maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/creator/OSGIArtifactIndexCreator.java
URL: http://svn.apache.org/viewvc/maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/creator/OSGIArtifactIndexCreator.java?rev=1158276&r1=1158275&r2=1158276&view=diff
==============================================================================
--- maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/creator/OSGIArtifactIndexCreator.java (original)
+++ maven/indexer/trunk/indexer-core/src/main/java/org/apache/maven/index/creator/OSGIArtifactIndexCreator.java Tue Aug 16 13:55:29 2011
@@ -41,6 +41,19 @@ import java.util.jar.Attributes;
 import java.util.jar.Manifest;
 
 /**
+ * This indexCreator will index some OSGI metadatas.
+ * <br/>
+ * All jars are indexed and not only the ones with packaging bundle.
+ * <br/>
+ * <p>
+ * OSGI metadatas indexed :
+ * <ul>
+ *   <li>Bundle-SymbolicName</li>
+ *   <li>Bundle-Version</li>
+ *   <li>Export-Package</li>
+ *   <li>Export-Service</li>
+ * </ul>
+ * </p>
  * @author Olivier Lamy
  * @since 4.1.2
  */
@@ -252,4 +265,10 @@ public class OSGIArtifactIndexCreator
         }
         return updated;
     }
+
+    @Override
+    public String toString()
+    {
+        return ID;
+    }
 }