commons-codec/xdocs/index.xml at bad2fbafa1b05118445810ef44a3940eef26abfa · apache/commons-codec · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?xml version="1.0"?>

<document>

 <properties>
  <title>Commons Codec</title>
  <author email="tobrien@apache.org">Tim O'Brien</author>
 </properties>

 <body>

  <section name="Commons Codec">

   <p>
    Welcome.  Commons Codec provides implementations of common
    encoders and decoders such as Base64, Hex, various phonetic
    encodings, and URLs.
   </p>

  </section>

  <section name="Impetus">
   <p>
     Codec was formed as an attempt to focus development effort on one
     definitive implementation of the Base64 encoder.  At the time of
     Codec's proposal, there were approximately 34 different Java
     classes that dealt with Base64 encoding spread over the
     Foundation's CVS repository.  Developers in the Jakarta Tomcat
     project had implemented an original version of the Base64 codec
     which had been copied by the Commons HttpClient and Apache XML
     project's XML-RPC subproject.  After almost one year, the two
     forked versions of Base64 had significantly diverged from one
     another.  XML-RPC had applied numerous fixes and patches which
     were not applied to the Commons HttpClient Base64.  Different
     subprojects had differing implementations at various levels
     of compliance with the RFC 2045.
   </p>
   <p>
     Out of that confusing duplication of effort sprang this simple
     attempt to encourage code reuse among various projects.  While
     this package contains a abstract framework for the creation of
     encoders and decoders, Codec itself is primarily focused on
     providing functional utilities for working with common encodings.
   </p>
  </section>

  <section name="Releases">
   <ul>
    <li>Version 1.1 (from mirror)
     <a href="http://jakarta.apache.org/site/binindex.cgi">binary</a>
     <a href="http://jakarta.apache.org/site/sourceindex.cgi">source</a> (latest)</li>
   </ul>
  </section>

  <section name="Components">

   <p>
 	Codec is currently comprised of a modest set of utilities and a
 	simple framework for encoding and decoding both textual and binary data.
   </p>

   <subsection name="Common Encoders">
   	<table>
     <tr>
      <td width="125">
       <a href="apidocs/org/apache/commons/codec/binary/Base64.html">
       	Base64</a>
      </td>
      <td>
       Provides Base64 content-transfer-encoding as defined in
       <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. This
       encoder can optionally create 76 character chunked output
       for strict adherence to RFC 2045.
      </td>
     </tr>
     <tr>
      <td>
       <a href="apidocs/org/apache/commons/codec/binary/Hex.html">
       	Hex</a>
      </td>
      <td>
       Converts an array of bytes into an array of characters representing the
       hexadecimal values of each byte in order
      </td>
     </tr>
    </table>
   </subsection>

   <subsection name="Language Encoders">
    <table>
     <tr>
      <td width="125">
       <a href="apidocs/org/apache/commons/codec/language/Soundex.html">
       	Soundex</a>
      </td>
      <td>
       Implementation of the Soundex algorithm.
      </td>
     </tr>
     <tr>
      <td>
       <a href="apidocs/org/apache/commons/codec/language/Metaphone.html">
       	Metaphone</a>
      </td>
      <td>
       Implementation of the Metaphone algorithm.
      </td>
     </tr>
     <tr>
      <td>
       <a href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">
       	Refined Soundex</a>
      </td>
      <td>
       Alternative implementation of the Soundex algorithm.
      </td>
     </tr>
     <tr>
      <td>
       <a href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">
       	Double Metaphone</a>
      </td>
      <td>
       Alternative implementation of the Metaphone algorithm.
      </td>
     </tr>

    </table>
   </subsection>

   <subsection name="Digest Utilites">
   	<table>
     <tr>
      <td width="125">
       <a href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">
       	DigestUtils</a>
      </td>
      <td>
        Provides simple static methods for creating a SHA or MD5 digest
      </td>
     </tr>
    </table>
   </subsection>

  </section>

 </body>
</document>