[commons-codec] branch master updated: BaseNCodecOutputStream.eof() should not throw IOException

[gg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git


The following commit(s) were added to refs/heads/master by this push:
     new dc4af3f0 BaseNCodecOutputStream.eof() should not throw IOException
dc4af3f0 is described below

commit dc4af3f0f5a53d2bb26369e950e68bf8f9098b55
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jun 4 10:54:35 2023 -0400

    BaseNCodecOutputStream.eof() should not throw IOException
---
 src/changes/changes.xml                                               | 2 ++
 .../java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java  | 4 +---
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 5a3aeac8..9acae476 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -55,6 +55,8 @@ The <action> type attribute can be add,update,fix,remove.
       <action                   dev="ggregory" type="fix" due-to="Arturo Bernal">Avoid use toString() or substring() in favor of a simplified expression #126.</action>
       <action issue="CODEC-305" dev="aherbert" type="fix" due-to="Florian">Fix byte-skipping in Base16 decoding #135.</action>
       <action                   dev="kinow" type="fix" due-to="Marc Wrobel">Fix several typos, improve writing in some javadocs #139.</action>
+      <action                   dev="ggregory" type="fix" due-to="Gary Gregory">BaseNCodecOutputStream.eof() should not throw IOException.</action>
+      <action                   dev="ggregory" type="fix" due-to="Gary Gregory">Javadoc improvements and cleanups.</action>
       <!-- ADD -->
       <action issue="CODEC-296" dev="mattsicker" type="add" due-to="Matt Sicker">Add support for Blake3 family of hashes.</action>
       <action                   dev="ggregory" type="add">Add github/codeql-action.</action>
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
index 7992a774..b3f141ab 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
@@ -82,11 +82,9 @@ public class BaseNCodecOutputStream extends FilterOutputStream {
     /**
      * Writes EOF.
      *
-     * @throws IOException
-     *             if an I/O error occurs.
      * @since 1.11
      */
-    public void eof() throws IOException {
+    public void eof() {
         // Notify encoder of EOF (-1).
         if (doEncode) {
             baseNCodec.encode(singleByte, 0, EOF, context);