Updated JavaDocs

phax · Aug 1, 2023 · 933d2d8 · 933d2d8
1 parent f4945ee
commit 933d2d8
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 5 deletions.
diff --git a/phase4-lib/src/main/java/com/helger/phase4/sender/AbstractAS4MessageBuilder.java b/phase4-lib/src/main/java/com/helger/phase4/sender/AbstractAS4MessageBuilder.java
@@ -216,32 +216,82 @@ public final IMPLTYPE cryptoFactory (@Nullable final IAS4CryptoFactory aCryptoFa
     return thisAsT ();
   }
 
+  /**
+   * Get the mutable AS4 signing parameters.
+   *
+   * @return The AS4 signing parameters to use for this message. Never
+   *         <code>null</code>.
+   * @see #withSigningParams(Consumer)
+   * @see #cryptParams()
+   * @see #withCryptParams(Consumer)
+   * @since 2.1.4
+   */
   @Nonnull
   @ReturnsMutableObject
   public final AS4SigningParams signingParams ()
   {
     return m_aSigningParams;
   }
 
+  /**
+   * Modify the AS4 signing parameters for this message. This is a version that
+   * maintains chainability of the API.
+   *
+   * @param aConsumer
+   *        Consumer for the AS4 signing parameters to use for this message.
+   *        Must not be <code>null</code>.
+   * @return this for chaining
+   * @see #signingParams()
+   * @see #cryptParams()
+   * @see #withCryptParams(Consumer)
+   * @since 2.1.4
+   */
   @Nonnull
   @ReturnsMutableObject
-  public final IMPLTYPE withSigningParams (@Nonnull final Consumer <AS4SigningParams> aConsumer)
+  public final IMPLTYPE withSigningParams (@Nonnull final Consumer <? super AS4SigningParams> aConsumer)
   {
+    ValueEnforcer.notNull (aConsumer, "Consumer");
+
     aConsumer.accept (m_aSigningParams);
     return thisAsT ();
   }
 
+  /**
+   * Get the mutable AS4 crypt parameters.
+   *
+   * @return The AS4 crypt parameters to use for this message. Never
+   *         <code>null</code>.
+   * @see #signingParams()
+   * @see #withSigningParams(Consumer)
+   * @see #withCryptParams(Consumer)
+   * @since 2.1.4
+   */
   @Nonnull
   @ReturnsMutableObject
   public final AS4CryptParams cryptParams ()
   {
     return m_aCryptParams;
   }
 
+  /**
+   * Modify the AS4 crypt parameters for this message. This is a version that
+   * maintains chainability of the API.
+   *
+   * @param aConsumer
+   *        Consumer for the AS4 crypt parameters to use for this message. Must
+   *        not be <code>null</code>.
+   * @return this for chaining
+   * @see #signingParams()
+   * @see #withSigningParams(Consumer)
+   * @see #cryptParams()
+   * @since 2.1.4
+   */
   @Nonnull
   @ReturnsMutableObject
-  public final IMPLTYPE withCryptParams (@Nonnull final Consumer <AS4CryptParams> aConsumer)
+  public final IMPLTYPE withCryptParams (@Nonnull final Consumer <? super AS4CryptParams> aConsumer)
   {
+    ValueEnforcer.notNull (aConsumer, "Consumer");
+
     aConsumer.accept (m_aCryptParams);
     return thisAsT ();
   }

diff --git a/phase4-lib/src/main/java/com/helger/phase4/sender/AbstractAS4UserMessageBuilder.java b/phase4-lib/src/main/java/com/helger/phase4/sender/AbstractAS4UserMessageBuilder.java
@@ -567,9 +567,6 @@ public boolean isEveryRequiredFieldSet ()
 
     // m_aMessageProperties is final
 
-    // m_aSessionKeyProvider is optional
-    // m_aReceiverCertificate is optional
-    // m_sReceiverCertificateAlias is optional
     if (StringHelper.hasNoText (m_sEndpointURL))
     {
       LOGGER.warn ("The field 'endpointURL' is not set");