Improved comments

Author: phax

phase4-lib/src/main/java/com/helger/phase4/util/AS4ResourceHelper.java

@@ -44,10 +44,9 @@
 import com.helger.phase4.logging.Phase4LoggerFactory;
 
 /**
- * A resource manager that keeps track of temporary files and other closables
- * that will be closed when this manager is closed. When calling
- * {@link #createTempFile()} a new filename is created and added to the list.
- * When using {@link #addCloseable(Closeable)} the Closable is added for
+ * A resource manager that keeps track of temporary files and other closables that will be closed
+ * when this manager is closed. When calling {@link #createTempFile()} a new filename is created and
+ * added to the list. When using {@link #addCloseable(Closeable)} the Closable is added for
  * postponed closing.
  *
  * @author Philip Helger
@@ -61,8 +60,7 @@ public class AS4ResourceHelper implements Closeable
   private static File s_aTempDir;
 
   /**
-   * @return The temp file directory to use, or <code>null</code> for the system
-   *         default.
+   * @return The temp file directory to use, or <code>null</code> for the system default.
    */
   @Nullable
   public static File getTempDir ()
@@ -74,8 +72,8 @@ public static File getTempDir ()
    * Set a temporary directory to use.
    *
    * @param aTempDir
-   *        The directory to use. It must be an existing directory. May be
-   *        <code>null</code> to use the system default.
+   *        The directory to use. It must be an existing directory. May be <code>null</code> to use
+   *        the system default.
    * @throws IllegalArgumentException
    *         If the directory does not exist
    */
@@ -100,8 +98,8 @@ public AS4ResourceHelper ()
   {}
 
   /**
-   * @return A new temporary {@link File} that will be deleted when
-   *         {@link #close()} is called.
+   * @return A new temporary {@link File} that will be deleted when {@link #close()} is called on
+   *         this instance.
    * @throws IOException
    *         When temp file creation fails.
    * @throws IllegalStateException
@@ -130,8 +128,7 @@ public File createTempFile () throws IOException
   }
 
   /**
-   * @return A list of all known temp files. Never <code>null</code> but maybe
-   *         empty.
+   * @return A list of all known temp files. Never <code>null</code> but maybe empty.
    * @since 0.8.3
    */
   @Nonnull
@@ -160,8 +157,7 @@ public void addCloseable (@Nonnull final Closeable aCloseable)
   }
 
   /**
-   * @return A list of all known closables. Never <code>null</code> but maybe
-   *         empty.
+   * @return A list of all known closables. Never <code>null</code> but maybe empty.
    * @since 0.8.3
    */
   @Nonnull
@@ -194,17 +190,17 @@ public void close ()
       }
 
       // Get and delete all temp files
-      final ICommonsList <File> aFiles = m_aRWLock.writeLockedGet ( () -> {
+      final ICommonsList <File> aTempFiles = m_aRWLock.writeLockedGet ( () -> {
         final ICommonsList <File> ret = m_aTempFiles.getClone ();
         m_aTempFiles.clear ();
         return ret;
       });
-      if (aFiles.isNotEmpty ())
+      if (aTempFiles.isNotEmpty ())
       {
         if (LOGGER.isDebugEnabled ())
-          LOGGER.debug ("Deleting " + aFiles.size () + " temporary " + CAS4.LIB_NAME + " files");
+          LOGGER.debug ("Deleting " + aTempFiles.size () + " temporary " + CAS4.LIB_NAME + " files");
 
-        for (final File aFile : aFiles)
+        for (final File aFile : aTempFiles)
         {
           if (LOGGER.isDebugEnabled ())
             LOGGER.debug ("Deleting temporary file '" + aFile.getAbsolutePath () + "'");
@@ -223,14 +219,12 @@ public void close ()
   }
 
   /**
-   * Ensure the provided {@link HttpEntity} can be read more than once. If the
-   * provided entity is not repeatable a temporary file is created and a new
-   * file-based Http Entity is created.
+   * Ensure the provided {@link HttpEntity} can be read more than once. If the provided entity is
+   * not repeatable a temporary file is created and a new file-based Http Entity is created.
    *
    * @param aSrcEntity
    *        The source Http entity. May not be <code>null</code>.
-   * @return A non-<code>null</code> Http entity that can be read more than
-   *         once.
+   * @return A non-<code>null</code> Http entity that can be read more than once.
    * @throws IOException
    *         on IO error
    * @since v0.9.9

phase4-peppol-client/src/main/java/com/helger/phase4/peppol/Phase4PeppolSender.java

@@ -1393,18 +1393,19 @@ protected ESuccess finishFields (@Nonnull final AS4ResourceHelper aResHelper) th
       if (m_aSBDDocumentConsumer != null)
         m_aSBDDocumentConsumer.accept (aSBD);
 
-      if (true)
+      if (false)
       {
         // Serialize the SBDH to a temporary file
+        // Advantage: works with large files as well because it consumes less memory
         // Drawback: will not call the SBDH Byte Consumer
         try
         {
-          final File fTempSBD = aResHelper.createTempFile ();
-          new SBDMarshaller ().write (aSBD, fTempSBD);
+          final File aTempSBDFile = aResHelper.createTempFile ();
+          new SBDMarshaller ().write (aSBD, aTempSBDFile);
 
           // Now we have the main payload
           payload (AS4OutgoingAttachment.builder ()
-                                        .data (fTempSBD)
+                                        .data (aTempSBDFile)
                                         .mimeType (m_aPayloadMimeType)
                                         .compression (m_bCompressPayload ? EAS4CompressionMode.GZIP : null)
                                         .contentID (m_sPayloadContentID));