From 70f5588f4abf3b6103153040f41ba68715d00a8f Mon Sep 17 00:00:00 2001 From: Adam Retter <adam.retter@googlemail.com> Date: Tue, 18 Jun 2024 10:52:15 +0200 Subject: [PATCH 1/4] Fix Javadoc --- .../src/main/java/net/iharder/Base64.java | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/http-client-java/src/main/java/net/iharder/Base64.java b/http-client-java/src/main/java/net/iharder/Base64.java index df5d04c..8cb9fbd 100644 --- a/http-client-java/src/main/java/net/iharder/Base64.java +++ b/http-client-java/src/main/java/net/iharder/Base64.java @@ -2,7 +2,7 @@ * <p>Encodes and decodes to and from Base64 notation.</p> * <p>Homepage: <a href="http://iharder.net/base64">http://iharder.net/base64</a>.</p> * - * <p>The <tt>options</tt> parameter, which appears in a few places, is used to pass + * <p>The options parameter, which appears in a few places, is used to pass * several pieces of information to the encoder. In the "higher level" methods such as * encodeBytes( bytes, options ) the options parameter can be used to indicate such * things as first gzipping the bytes before encoding them, not inserting linefeeds @@ -53,9 +53,9 @@ * when data that's being decoded is gzip-compressed and will decompress it * automatically. Generally things are cleaner. You'll probably have to * change some method calls that you were making to support the new - * options format (<tt>int</tt>s that you "OR" together).</li> + * options format (int(s) that you "OR" together).</li> * <li>v1.5.1 - Fixed bug when decompressing and decoding to a - * byte[] using <tt>decode( String s, boolean gzipCompressed )</tt>. + * byte[] using {@code decode( String s, boolean gzipCompressed )}. * Added the ability to "suspend" encoding in the Output Stream so * you can turn on and off the encoding if you need to embed base64 * data in an otherwise "normal" stream (like an XML file).</li> @@ -524,7 +524,7 @@ private static byte[] encode3to4( * Serializes an object and returns the Base64-encoded * version of that serialized object. If the object * cannot be serialized or there is another error, - * the method will return <tt>null</tt>. + * the method will return null. * The object is not GZip-compressed before being encoded. * * @param serializableObject The object to encode @@ -542,7 +542,7 @@ public static String encodeObject( java.io.Serializable serializableObject ) * Serializes an object and returns the Base64-encoded * version of that serialized object. If the object * cannot be serialized or there is another error, - * the method will return <tt>null</tt>. + * the method will return null. * <p> * Valid options:<pre> * GZIP: gzip-compresses object before encoding it. @@ -1049,7 +1049,7 @@ public static byte[] decode( String s, int options ) /** * Attempts to decode Base64 data and deserialize a Java - * Object within. Returns <tt>null</tt> if there was an error. + * Object within. Returns null if there was an error. * * @param encodedObject The Base64 data to decode * @return The decoded and deserialized object @@ -1097,7 +1097,7 @@ public static Object decodeToObject( String encodedObject ) * * @param dataToEncode byte array of data to encode in base64 form * @param filename Filename for saving encoded data - * @return <tt>true</tt> if successful, <tt>false</tt> otherwise + * @return true if successful, false otherwise * * @since 2.1 */ @@ -1131,7 +1131,7 @@ public static boolean encodeToFile( byte[] dataToEncode, String filename ) * * @param dataToDecode Base64-encoded data as a string * @param filename Filename for saving decoded data - * @return <tt>true</tt> if successful, <tt>false</tt> otherwise + * @return true if successful, false otherwise * * @since 2.1 */ @@ -1268,7 +1268,7 @@ public static String encodeFromFile( String filename ) /** - * Reads <tt>infile</tt> and encodes it to <tt>outfile</tt>. + * Reads infile and encodes it to outfile. * * @param infile Input file * @param outfile Output file @@ -1305,7 +1305,7 @@ public static boolean encodeFileToFile( String infile, String outfile ) /** - * Reads <tt>infile</tt> and decodes it to <tt>outfile</tt>. + * Reads infile and decodes it to outfile. * * @param infile Input file * @param outfile Output file @@ -1346,7 +1346,7 @@ public static boolean decodeFileToFile( String infile, String outfile ) /** * A {@link Base64.InputStream} will read data from another - * <tt>java.io.InputStream</tt>, given in the constructor, + * {@link java.io.InputStream}, given in the constructor, * and encode/decode to/from Base64 notation on the fly. * * @see Base64 @@ -1369,7 +1369,7 @@ public static class InputStream extends java.io.FilterInputStream /** * Constructs a {@link Base64.InputStream} in DECODE mode. * - * @param in the <tt>java.io.InputStream</tt> from which to read data. + * @param in the {@link java.io.InputStream} from which to read data. * @since 1.3 */ public InputStream( java.io.InputStream in ) @@ -1392,7 +1392,7 @@ public InputStream( java.io.InputStream in ) * Example: <code>new Base64.InputStream( in, Base64.DECODE )</code> * * - * @param in the <tt>java.io.InputStream</tt> from which to read data. + * @param in the {@link java.io.InputStream} from which to read data. * @param options Specified options * @see Base64#ENCODE * @see Base64#DECODE @@ -1582,7 +1582,7 @@ else if( i == 0 ) /** * A {@link Base64.OutputStream} will write data to another - * <tt>java.io.OutputStream</tt>, given in the constructor, + * {@link java.io.OutputStream}, given in the constructor, * and encode/decode to/from Base64 notation on the fly. * * @see Base64 @@ -1605,7 +1605,7 @@ public static class OutputStream extends java.io.FilterOutputStream /** * Constructs a {@link Base64.OutputStream} in ENCODE mode. * - * @param out the <tt>java.io.OutputStream</tt> to which data will be written. + * @param out the {@link java.io.OutputStream} to which data will be written. * @since 1.3 */ public OutputStream( java.io.OutputStream out ) @@ -1627,7 +1627,7 @@ public OutputStream( java.io.OutputStream out ) * <p> * Example: <code>new Base64.OutputStream( out, Base64.ENCODE )</code> * - * @param out the <tt>java.io.OutputStream</tt> to which data will be written. + * @param out the {@link java.io.OutputStream} to which data will be written. * @param options Specified options. * @see Base64#ENCODE * @see Base64#DECODE From 6d9f2c08042f1a78cee0de3c1172634fc20fdf5a Mon Sep 17 00:00:00 2001 From: Adam Retter <adam.retter@googlemail.com> Date: Tue, 18 Jun 2024 12:21:51 +0200 Subject: [PATCH 2/4] fixup! Fix Javadoc --- http-client-parent/pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/http-client-parent/pom.xml b/http-client-parent/pom.xml index 293f459..edd9fc5 100644 --- a/http-client-parent/pom.xml +++ b/http-client-parent/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>org.expath</groupId> <artifactId>expath-parent</artifactId> - <version>1.4.0</version> + <version>1.5.0</version> <relativePath /> </parent> @@ -54,5 +54,5 @@ </dependency> </dependencies> </dependencyManagement> - + </project> From 43b66fc5a7d445b8ac3bafcc9cb9fc76c299ed99 Mon Sep 17 00:00:00 2001 From: Adam Retter <adam.retter@googlemail.com> Date: Tue, 18 Jun 2024 12:26:51 +0200 Subject: [PATCH 3/4] Use the latest expath-parent dependency (v 1.6.2) that is compatible with Saxon 10 --- http-client-parent/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/http-client-parent/pom.xml b/http-client-parent/pom.xml index edd9fc5..01a1b90 100644 --- a/http-client-parent/pom.xml +++ b/http-client-parent/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>org.expath</groupId> <artifactId>expath-parent</artifactId> - <version>1.5.0</version> + <version>1.6.2</version> <relativePath /> </parent> From 57957e00cd43e231fcd1c522bb41b1e2d63c59df Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 18 Jun 2024 10:32:04 +0000 Subject: [PATCH 4/4] Bump org.apache.james:apache-mime4j-core in /http-client-java Bumps org.apache.james:apache-mime4j-core from 0.8.4 to 0.8.10. --- updated-dependencies: - dependency-name: org.apache.james:apache-mime4j-core dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> --- http-client-java/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/http-client-java/pom.xml b/http-client-java/pom.xml index cbabe9c..f9a2394 100644 --- a/http-client-java/pom.xml +++ b/http-client-java/pom.xml @@ -75,7 +75,7 @@ <dependency> <groupId>org.apache.james</groupId> <artifactId>apache-mime4j-core</artifactId> - <version>0.8.4</version> + <version>0.8.10</version> </dependency> <dependency> <groupId>org.slf4j</groupId>