Skip to content

Commit dfd60e3

Browse files
author
Timothy O'Brien
committed
Moved 1.1 release notes to new file and prepared releas notes for the 1.1.1 maint rel. Added/modified documentation
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/codec/trunk@130147 13f79535-47bb-0310-9956-ffa450edef68
1 parent 7dcc591 commit dfd60e3

8 files changed

Lines changed: 132 additions & 96 deletions

File tree

‎RELEASE-NOTES-1.1.txt‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
$Id: RELEASE-NOTES-1.1.txt,v 1.1 2003/05/29 21:14:58 tobrien Exp $
2+
3+
Commons Codec Package
4+
Version 1.1
5+
Release Notes
6+
7+
8+
INTRODUCTION:
9+
10+
This document contains the release notes for this version of the Commons
11+
Codec package, and highlights changes since the previous version. Version
12+
1.1 is the first official release of Codec. Numerous projects had been
13+
depending on Version 1.0-dev while Codec was in the Sandbox, and backwards
14+
compatibility has been preserved to ease the transition to this official
15+
release.
16+
17+
NEW FEATURES:
18+
19+
* A newer version of the Base64 class reflecting improvements from
20+
both the commons-httpclient and xml-rpc versions of code forked
21+
from catalina.
22+
* Base64 class from commons-httpclient in org.apache.commons.codec.base64
23+
has been retained for backwards compatibility but has been deprecated
24+
* Soundex class from commons-util in org.apache.commons.codec
25+
* Metaphone class from commons-util in org.apache.commons.codec
26+
* RefinedSoundex class in org.apache.commons.codec
27+
* Encoder/Decoder interfaces in org.apache.commons
28+
* String and Binary specific Encoder/Decoder interfaces in
29+
org.apache.commons
30+
* StringEncoderComparator replaces the SoundexComparator from the
31+
language package.
32+
33+
BUG FIXES:
34+
35+
* Base64 now discards whitespace characters when decoding encoded
36+
content.

‎RELEASE-NOTES.txt‎

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
1-
$Id: RELEASE-NOTES.txt,v 1.3 2003/04/29 22:16:08 tobrien Exp $
1+
$Id: RELEASE-NOTES.txt,v 1.4 2003/05/29 21:14:58 tobrien Exp $
22

33
Commons Codec Package
4-
Version 1.1
4+
Version 1.1.1
55
Release Notes
66

77

88
INTRODUCTION:
99

1010
This document contains the release notes for this version of the Commons
1111
Codec package, and highlights changes since the previous version. Version
12-
1.1 is the first official release of Codec. Numerous projects had been
13-
depending on Version 1.0-dev while Codec was in the Sandbox, and backwards
14-
compatibility has been preserved to ease the transition to this official
15-
release.
12+
1.1.1 contains a bug fix for the 1.1 release, and addresses an issue related
13+
to the treat of non-Base64 characters.
14+
1615

1716
NEW FEATURES:
1817

19-
* A newer version of the Base64 class reflecting improvements from
20-
both the commons-httpclient and xml-rpc versions of code forked
21-
from catalina.
22-
* Base64 class from commons-httpclient in org.apache.commons.codec.base64
23-
has been retained for backwards compatibility but has been deprecated
24-
* Soundex class from commons-util in org.apache.commons.codec
25-
* Metaphone class from commons-util in org.apache.commons.codec
26-
* RefinedSoundex class in org.apache.commons.codec
27-
* Encoder/Decoder interfaces in org.apache.commons
28-
* String and Binary specific Encoder/Decoder interfaces in
29-
org.apache.commons
30-
* StringEncoderComparator replaces the SoundexComparator from the
31-
language package.
18+
* None
3219

3320
BUG FIXES:
3421

35-
* Base64 now discards whitespace characters when decoding encoded
36-
content.
22+
* Fix for Bug 19860: Modified Base64 to remedy non-compliance with RFC
23+
2045. Non-Base64 characters were not being discarded during the
24+
decode. RFC 2045 explicitly states that all characters outside of the
25+
base64 alphabet are to be ignored. A new function discardNonBase64 is
26+
called prior to a decode. Note that isArrayBase64 only discards
27+
whitespace before testing the contents of an encoded byte array. Unit
28+
tests for Base64 were updated to reflect the changes related to
29+
discarding non-Base64 characters.
30+
31+
32+

‎project.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,13 @@
9696
</contributors>
9797

9898
<dependencies>
99-
<!-- <dependency>
99+
<!-- <dependency>
100100
<id>junit</id>
101101
<version>3.8</version>
102102
</dependency> -->
103103
</dependencies>
104104

105-
<issueTrackingUrl>http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Commons&amp;component=Sandbox&amp;short_desc=&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;cmdtype=doit&amp;order=%27Importance%27</issueTrackingUrl>
105+
<issueTrackingUrl>http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=Codec&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time</issueTrackingUrl>
106106

107107
<repository>
108108
<connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:jakarta-commons/${pom.artifactId.substring(8)}</connection>

‎src/java/org/apache/commons/codec/base64/package.html‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<html>
2-
<body>
3-
<b>Deprecated</b><i> and replaced by {@link org.apache.commons.codec.binary}</i>.
4-
</body>
5-
</html>
2+
<body>
3+
<b>Deprecated</b>
4+
<i> and replaced by {@link org.apache.commons.codec.binary}</i>.
5+
This package will be removed in release 1.2.
6+
</body>
7+
</html>

‎src/java/org/apache/commons/codec/binary/package.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<html>
2-
<body>
3-
Utilities for Base64 and Hexadecimal String encoding and decoding.
4-
</body>
5-
</html>
2+
<body>
3+
Utilities for Base64 and Hexadecimal String encoding and decoding.
4+
</body>
5+
</html>

‎src/java/org/apache/commons/codec/language/RefinedSoundex.java‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,9 @@
6262
* "Soundex" method originally developed by Margaret Odell and
6363
* Robert Russell
6464
*
65-
* <!-- This link is broken: -->
66-
* <!-- @see <a href="http://www.bluepoof.com/Soundex/info2.html">http://www.bluepoof.com/Soundex/info2.html</a> -->
67-
*
6865
* @author tobrien@transolutions.net
6966
* @author ggregory@seagullsw.com
70-
* @version $Revision: 1.3 $ $Date: 2003/05/12 17:17:24 $
67+
* @version $Revision: 1.4 $ $Date: 2003/05/29 21:14:59 $
7168
*/
7269
public class RefinedSoundex implements StringEncoder {
7370

‎src/java/org/apache/commons/codec/language/package.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<html>
2-
<body>
3-
A number of commonly used language and phonetic encoders.
4-
</body>
5-
</html>
2+
<body>
3+
A number of commonly used language and phonetic encoders.
4+
</body>
5+
</html>

‎src/java/org/apache/commons/codec/package.html‎

Lines changed: 62 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,63 @@
11
<html>
2-
<body>
3-
Attempts to provide definitive implementations of commonly used encoders and decoders.
4-
<p>Codec is currently comprised of a modest set of utilities and a simple
5-
framework for String encoding and decoding in two main categories: Common
6-
Encoders and Language Encoders.</p>
7-
<h4>
8-
<a name="Common Encoders">Common Encoders</a>
9-
</h4>
10-
<table border="1" width="100%" cellspacing="2" cellpadding="3">
11-
<tr>
12-
<td>
13-
<a href="binary/Base64.html">
14-
org.apache.commons.codec.binary.Base64</a>
15-
</td>
16-
<td>
17-
Provides Base64 content-transfer-encoding as defined in
18-
<a href="http://www.ietf.org/rfc/rfc1521.txt">
19-
RFC 1521</a>
20-
</td>
21-
<td>Production</td>
22-
</tr>
23-
<tr>
24-
<td>
25-
<a href="binary/Hex.html">
26-
org.apache.commons.codec.binary.Hex</a>
27-
</td>
28-
<td>
29-
Converts an array of bytes into an array of characters representing the
30-
hexidecimal values of each byte in order
31-
</td>
32-
<td>Production</td>
33-
</tr>
34-
</table>
35-
<h4>
36-
<a name="Language Encoders">Language Encoders</a>
37-
</h4>
38-
<p>Codec contains a number of commonly used language and phonetic encoders</p>
39-
<table border="1" width="100%" cellspacing="2" cellpadding="3">
40-
<tr>
41-
<td>
42-
<a href="language/Soundex.html">
43-
org.apache.commons.codec.language.Soundex</a>
44-
</td>
45-
<td>Implementation of the Soundex algorithm.</td>
46-
<td>Production</td>
47-
</tr>
48-
<tr>
49-
<td>
50-
<a href="language/Metaphone.html">
51-
org.apache.commons.codec.language.Metaphone</a>
52-
</td>
53-
<td>Implementation of the Metaphone algorithm.</td>
54-
<td>Production</td>
55-
</tr>
56-
</table>
57-
</body>
58-
</html>
2+
<body>
3+
Definitive implementations of commonly used encoders
4+
and decoders.
5+
<p>
6+
Codec is currently comprised of a modest set of utilities and a
7+
simple framework for String encoding and decoding in two main
8+
categories: Common Encoders and Language Encoders.
9+
</p>
10+
<h4>
11+
<a name="Common Encoders">Common Encoders</a>
12+
</h4>
13+
<table border="1" width="100%" cellspacing="2" cellpadding="3">
14+
<tr>
15+
<td>
16+
<a href="binary/Base64.html">
17+
org.apache.commons.codec.binary.Base64</a>
18+
</td>
19+
<td>
20+
Provides Base64 content-transfer-encoding as defined in
21+
<a href="http://www.ietf.org/rfc/rfc2045.txt">
22+
RFC 2045</a>
23+
</td>
24+
<td>Production</td>
25+
</tr>
26+
<tr>
27+
<td>
28+
<a href="binary/Hex.html">
29+
org.apache.commons.codec.binary.Hex</a>
30+
</td>
31+
<td>
32+
Converts an array of bytes into an array of characters representing the
33+
hexidecimal values of each byte in order
34+
</td>
35+
<td>Production</td>
36+
</tr>
37+
</table>
38+
<h4>
39+
<a name="Language Encoders">Language Encoders</a>
40+
</h4>
41+
<p>
42+
Codec contains a number of commonly used language and phonetic encoders
43+
</p>
44+
<table border="1" width="100%" cellspacing="2" cellpadding="3">
45+
<tr>
46+
<td>
47+
<a href="language/Soundex.html">
48+
org.apache.commons.codec.language.Soundex</a>
49+
</td>
50+
<td>Implementation of the Soundex algorithm.</td>
51+
<td>Production</td>
52+
</tr>
53+
<tr>
54+
<td>
55+
<a href="language/Metaphone.html">
56+
org.apache.commons.codec.language.Metaphone</a>
57+
</td>
58+
<td>Implementation of the Metaphone algorithm.</td>
59+
<td>Production</td>
60+
</tr>
61+
</table>
62+
</body>
63+
</html>

0 commit comments

Comments
 (0)