You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2008/10/18 22:32:07 UTC
svn commit: r705918 -
/maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/
Author: hboutemy
Date: Sat Oct 18 13:32:07 2008
New Revision: 705918
URL: http://svn.apache.org/viewvc?rev=705918&view=rev
Log:
improved javadoc
Modified:
maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java
maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java
maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java
maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java
maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java
Modified: maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java?rev=705918&r1=705917&r2=705918&view=diff
==============================================================================
--- maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java (original)
+++ maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/AppendingTransformer.java Sat Oct 18 13:32:07 2008
@@ -28,6 +28,10 @@
import org.codehaus.plexus.util.IOUtil;
+/**
+ * A resource processor that appends content for a resource, separated by a newline.
+ *
+ */
public class AppendingTransformer
implements ResourceTransformer
{
Modified: maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java?rev=705918&r1=705917&r2=705918&view=diff
==============================================================================
--- maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java (original)
+++ maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ComponentsXmlResourceTransformer.java Sat Oct 18 13:32:07 2008
@@ -39,12 +39,10 @@
import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.codehaus.plexus.util.xml.Xpp3DomWriter;
-// 1. We want to process all resources that are common in all the JARs that we are processing.
-// 2. At the end of processing we want to hand back the transformation of the resources.
-
-// In my particular case I want to grab all the plexus components.xml files and aggregate them
-// and then stick them in one place in the aggregated JAR.
-
+/**
+ * A resource processor that aggregates plexus <code>components.xml</code> files.
+ *
+ */
public class ComponentsXmlResourceTransformer
implements ResourceTransformer
{
Modified: maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java?rev=705918&r1=705917&r2=705918&view=diff
==============================================================================
--- maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java (original)
+++ maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/DontIncludeResourceTransformer.java Sat Oct 18 13:32:07 2008
@@ -24,7 +24,8 @@
import java.util.jar.JarOutputStream;
/**
- * Prevents duplicate copies of the license
+ * A resource processor that prevents the inclusion of an arbitrary
+ * resource into the shaded JAR.
*
*/
public class DontIncludeResourceTransformer
Modified: maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java?rev=705918&r1=705917&r2=705918&view=diff
==============================================================================
--- maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java (original)
+++ maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/IncludeResourceTransformer.java Sat Oct 18 13:32:07 2008
@@ -29,8 +29,8 @@
import org.codehaus.plexus.util.IOUtil;
/**
- * Prevents duplicate copies of the license
- *
+ * A resource processor that allows the addition of an arbitrary file
+ * content into the shaded JAR.
*/
public class IncludeResourceTransformer
implements ResourceTransformer
Modified: maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java?rev=705918&r1=705917&r2=705918&view=diff
==============================================================================
--- maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java (original)
+++ maven/plugins/trunk/maven-shade-plugin/src/main/java/org/apache/maven/plugins/shade/resource/ServicesResourceTransformer.java Sat Oct 18 13:32:07 2008
@@ -59,7 +59,7 @@
if ( data == null )
{
data = new ByteArrayOutputStream();
- serviceEntries.put( resource, data );
+ serviceEntries.put( resource, data );
}
return true;