[java-support] branch main updated: Javadoc fixes.

Scott Cantor cantor.2 at osu.edu
Thu Jul 7 14:26:27 UTC 2022


This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch main
in repository java-support.

View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=2258be2adc91029237f58700815a04a8fe4173a7

The following commit(s) were added to refs/heads/main by this push:
     new 2258be2  Javadoc fixes.
2258be2 is described below

commit 2258be2adc91029237f58700815a04a8fe4173a7
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Thu Jul 7 10:26:25 2022 -0400

    Javadoc fixes.
---
 .../net/shibboleth/utilities/java/support/ddf/DDF.java  |  9 ++++++++-
 .../java/support/ddf/RemotedHttpServletRequest.java     | 17 +++++++++++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/src/main/java/net/shibboleth/utilities/java/support/ddf/DDF.java b/src/main/java/net/shibboleth/utilities/java/support/ddf/DDF.java
index c65784e..29273e7 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/ddf/DDF.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/ddf/DDF.java
@@ -367,7 +367,7 @@ public class DDF implements Iterable<DDF> {
     /**
      * Set the node name.
      * 
-     * <p>For compatibility, the name is constrained to <= 255 characters.</p>
+     * <p>For compatibility, the name is constrained to no more than 255 characters.</p>
      * 
      * <p>The name will not be set if the node is already a child of a structure.</p>
      * 
@@ -1587,6 +1587,13 @@ public class DDF implements Iterable<DDF> {
         }
     }
     
+    /**
+     * Converts a byte into a hex character.
+     * 
+     * @param b input byte
+     * 
+     * @return the hex character equivalent (capitalized)
+     */
     private static int hexchar(final int b) {
         // 48 is '0' and 65 is 'A'
         return (b <= 9) ? (48 + b) : (65 + b - 10);
diff --git a/src/main/java/net/shibboleth/utilities/java/support/ddf/RemotedHttpServletRequest.java b/src/main/java/net/shibboleth/utilities/java/support/ddf/RemotedHttpServletRequest.java
index 1aa74c9..bf0a04e 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/ddf/RemotedHttpServletRequest.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/ddf/RemotedHttpServletRequest.java
@@ -603,65 +603,82 @@ public class RemotedHttpServletRequest implements HttpServletRequest {
         /** Underlying stream. */
         @Nonnull private final InputStream delegate;
 
+        /**
+         * Constructor.
+         *
+         * @param body body data
+         */
         public BodyInputStream(final byte[] body) {
             delegate = new ByteArrayInputStream(body);
         }
 
+        /** {@inheritDoc} */
         @Override
         public boolean isFinished() {
             return false;
         }
 
+        /** {@inheritDoc} */
         @Override
         public boolean isReady() {
             return true;
         }
 
+        /** {@inheritDoc} */
         @Override
         public void setReadListener(final ReadListener readListener) {
             throw new UnsupportedOperationException();
         }
 
+        /** {@inheritDoc} */
         @Override
         public int read() throws IOException {
             return delegate.read();
         }
 
+        /** {@inheritDoc} */
         @Override
         public int read(final byte[] b, final int off, final int len) throws IOException {
             return delegate.read(b, off, len);
         }
 
+        /** {@inheritDoc} */
         @Override
         public int read(final byte[] b) throws IOException {
             return delegate.read(b);
         }
 
+        /** {@inheritDoc} */
         @Override
         public long skip(final long n) throws IOException {
             return delegate.skip(n);
         }
 
+        /** {@inheritDoc} */
         @Override
         public int available() throws IOException {
             return delegate.available();
         }
 
+        /** {@inheritDoc} */
         @Override
         public void close() throws IOException {
             delegate.close();
         }
 
+        /** {@inheritDoc} */
         @Override
         public synchronized void mark(final int readlimit) {
             delegate.mark(readlimit);
         }
 
+        /** {@inheritDoc} */
         @Override
         public synchronized void reset() throws IOException {
             delegate.reset();
         }
 
+        /** {@inheritDoc} */
         @Override
         public boolean markSupported() {
             return delegate.markSupported();

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list