Author: tn
Date: Sat Nov 1 16:27:52 2014
New Revision: 1635986
URL: http://svn.apache.org/r1635986
Log:
[CODEC-185] Added clarification concerning the use of the urlSafe parameter to
Base64.
Modified:
commons/proper/codec/trunk/src/changes/changes.xml
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java
Modified: commons/proper/codec/trunk/src/changes/changes.xml
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/changes/changes.xml?rev=1635986&r1=1635985&r2=1635986&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/changes/changes.xml (original)
+++ commons/proper/codec/trunk/src/changes/changes.xml Sat Nov 1 16:27:52 2014
@@ -43,6 +43,7 @@ The <action> type attribute can be add,u
</properties>
<body>
<release version="1.10" date="DD Mmmm 2014" description="Feature and fix
release.">
+ <action dev="tn" type="fix" issue="CODEC-185" due-to="Sean Busbey">Added
clarification to javadoc of Base64 concerning the use of the urlSafe
parameter</action>
<action dev="tn" type="fix" issue="CODEC-191" due-to="Igor Savin">Added
clarification to the javadoc of Base[32|64]OutputStream that it is mandatory to
call close()</action>
<action dev="ggregory" type="fix" issue="CODEC-188" due-to="Hendrik
Saly">Add support for HMAC Message Authentication Code (MAC) digests</action>
<action dev="ggregory" type="fix" issue="CODEC-187" due-to="Michael
Tobias, Thomas Neidhart">Beider Morse Phonetic Matching producing incorrect
tokens</action>
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java
URL:
http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java?rev=1635986&r1=1635985&r2=1635986&view=diff
==============================================================================
---
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java
(original)
+++
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java
Sat Nov 1 16:27:52 2014
@@ -36,6 +36,9 @@ import java.math.BigInteger;
* <li>Line separator: Default is CRLF ("\r\n")</li>
* </ul>
* <p>
+ * The URL-safe parameter is only applied to encode operations. Decoding
seamlessly handles both modes.
+ * </p>
+ * <p>
* Since this class operates directly on byte streams, and not character
streams, it is hard-coded to only
* encode/decode character encodings which are compatible with the lower 127
ASCII chart (ISO-8859-1, Windows-1252,
* UTF-8, etc).
@@ -675,7 +678,10 @@ public class Base64 extends BaseNCodec {
}
/**
- * Decodes a Base64 String into octets
+ * Decodes a Base64 String into octets.
+ * <p>
+ * <b>Note:</b> this method seamlessly handles data encoded in URL-safe or
normal mode.
+ * </p>
*
* @param base64String
* String containing Base64 data
@@ -687,7 +693,10 @@ public class Base64 extends BaseNCodec {
}
/**
- * Decodes Base64 data into octets
+ * Decodes Base64 data into octets.
+ * <p>
+ * <b>Note:</b> this method seamlessly handles data encoded in URL-safe or
normal mode.
+ * </p>
*
* @param base64Data
* Byte array containing Base64 data
@@ -701,7 +710,7 @@ public class Base64 extends BaseNCodec {
// Implementation of integer encoding used for crypto
/**
- * Decodes a byte64-encoded integer according to crypto standards such as
W3C's XML-Signature
+ * Decodes a byte64-encoded integer according to crypto standards such as
W3C's XML-Signature.
*
* @param pArray
* a byte array containing base64 character data
@@ -713,7 +722,7 @@ public class Base64 extends BaseNCodec {
}
/**
- * Encodes to a byte64-encoded integer according to crypto standards such
as W3C's XML-Signature
+ * Encodes to a byte64-encoded integer according to crypto standards such
as W3C's XML-Signature.
*
* @param bigInt
* a BigInteger
