svn commit: r1618125 - /sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageExporter.java

[tommaso]

Author: tommaso
Date: Fri Aug 15 09:42:26 2014
New Revision: 1618125

URL: http://svn.apache.org/r1618125
Log:
SLING-3816 - fixed some javadoc issues

Modified:
    
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageExporter.java

Modified: 
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageExporter.java
URL: 
http://svn.apache.org/viewvc/sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageExporter.java?rev=1618125&r1=1618124&r2=1618125&view=diff
==============================================================================
--- 
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageExporter.java
 (original)
+++ 
sling/trunk/contrib/extensions/replication/core/src/main/java/org/apache/sling/replication/packaging/ReplicationPackageExporter.java
 Fri Aug 15 09:42:26 2014
@@ -19,25 +19,30 @@
 package org.apache.sling.replication.packaging;
 
 
+import java.util.List;
+
 import org.apache.sling.replication.communication.ReplicationRequest;
-import org.apache.sling.replication.packaging.ReplicationPackage;
 import 
org.apache.sling.replication.serialization.ReplicationPackageBuildingException;
 
-import java.util.List;
-
 /**
- * A {@link org.apache.sling.replication.packaging.ReplicationPackage ) 
exporter
+ * A {@link org.apache.sling.replication.packaging.ReplicationPackageExporter) 
is responsible of exporting
+ * {@link org.apache.sling.replication.packaging.ReplicationPackage}s to be 
then imported by a {@link org.apache.sling.replication.agent.ReplicationAgent}
+ * (via a {@link 
org.apache.sling.replication.packaging.ReplicationPackageImporter}).
  */
 public interface ReplicationPackageExporter {
+
     /**
-     * Exports a replication package.
-     * @return the first available package in the exporter.
+     * Exports the {@link 
org.apache.sling.replication.packaging.ReplicationPackage}s built from the
+     * passed {@link 
org.apache.sling.replication.communication.ReplicationRequest}.
+     *
+     * @return a <code>List</code> of {@link 
org.apache.sling.replication.packaging.ReplicationPackage}s
      */
     List<ReplicationPackage> exportPackage(ReplicationRequest 
replicationRequest) throws ReplicationPackageBuildingException;
 
     /**
-     * Exports a replication package.
-     * @return the first available package in the exporter.
+     * Exports a {@link 
org.apache.sling.replication.packaging.ReplicationPackage} given its 'id', if 
it already exists.
+     *
+     * @return a {@link 
org.apache.sling.replication.packaging.ReplicationPackage} if available, 
<code>null</code> otherwise
      */
     ReplicationPackage exportPackageById(String replicationPackageId);
 }