Skip to content

Commit 61ed11c

Browse files
garydgregorygarydgregory
committed
Convert separate user guide to Javadoc Overview
1 parent 4a76442 commit 61ed11c

File tree

3 files changed

+288
-349
lines changed

3 files changed

+288
-349
lines changed

‎src/main/javadoc/overview.html‎

Lines changed: 287 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,287 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
https://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<html>
18+
<head>
19+
<title>Apache Commons Codec Overview</title>
20+
</head>
21+
<body>
22+
<p>Apache Commons Codec consists of a set of utilities and a simple
23+
framework for encoding and decoding text and binary data.</p>
24+
<p>
25+
You can find the Javadoc package list at the <a href="#all-packages-table">bottom of this page</a>.
26+
</p>
27+
<section>
28+
<h1>Binary Encoders</h1>
29+
<p>Interfaces and classes used by the various implementations in
30+
the sub-packages.</p>
31+
<table>
32+
<caption>Binary Encoders</caption>
33+
<tr>
34+
<td><a
35+
href="apidocs/org/apache/commons/codec/binary/Base32.html">Base32
36+
</a></td>
37+
<td>Provides Base32 encoding and decoding as defined by <a
38+
href="https://www.ietf.org/rfc/rfc4648.txt">RFC 4648</a>
39+
</td>
40+
</tr>
41+
<tr>
42+
<td><a
43+
href="apidocs/org/apache/commons/codec/binary/Base32InputStream.html">Base32InputStream
44+
</a></td>
45+
<td>Provides Base32 encoding and decoding in a streaming
46+
fashion (unlimited size).</td>
47+
</tr>
48+
<tr>
49+
<td><a
50+
href="apidocs/org/apache/commons/codec/binary/Base64.html">
51+
Base64 </a></td>
52+
<td>Provides Base64 encoding and decoding as defined by <a
53+
href="https://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>
54+
</td>
55+
</tr>
56+
<tr>
57+
<td><a
58+
href="apidocs/org/apache/commons/codec/binary/Base64InputStream.html">Base64InputStream
59+
</a></td>
60+
<td>Provides Base64 encoding and decoding in a streaming
61+
fashion (unlimited size).</td>
62+
</tr>
63+
<tr>
64+
<td><a
65+
href="apidocs/org/apache/commons/codec/binary/BinaryCodec.html">
66+
BinaryCodec </a></td>
67+
<td>Converts between byte arrays and strings of "0"s and "1"s.</td>
68+
</tr>
69+
<tr>
70+
<td><a href="apidocs/org/apache/commons/codec/binary/Hex.html">
71+
Hex </a></td>
72+
<td>Converts hexadecimal Strings.</td>
73+
</tr>
74+
</table>
75+
</section>
76+
<section>
77+
<h1>Digest Encoders</h1>
78+
<p>
79+
<strong>WARNING:</strong> Some of the functions in this package might
80+
not be suitable for cryptography, or are no longer
81+
cryptographically-secure.
82+
</p>
83+
<table>
84+
<caption>Digest Encoders</caption>
85+
<tr>
86+
<td><a
87+
href="apidocs/org/apache/commons/codec/digest/Blake3.html">Blake3</a>
88+
</td>
89+
<td>Provides a pure Java implementation of the <a
90+
href="https://github.com/BLAKE3-team/BLAKE3">Blake3 hash
91+
function</a> which can be used for computing <a
92+
href="https://en.wikipedia.org/wiki/Cryptographic_hash_function">cryptographic
93+
hashes</a> (message digests) which are extensible to arbitrary output
94+
lengths (known as an <i>extensible-output function</i> or <i>XOF</i>),
95+
computing <a
96+
href="https://en.wikipedia.org/wiki/Message_authentication_code">message
97+
authentication codes</a> using a 32 byte (256-bit) secret key,
98+
computing subkeys from a primary key using a <a
99+
href="https://en.wikipedia.org/wiki/Key_derivation_function">key
100+
derivation function</a>, and can be used as the basis for a <a
101+
href="https://en.wikipedia.org/wiki/Cryptographically-secure_pseudorandom_number_generator">
102+
cryptographically-secure pseudorandom number generator</a>. <br /> <strong>WARNING:</strong>
103+
Blake3 is <em>not</em> a password hashing algorithm! An algorithm
104+
such as <a href="https://github.com/P-H-C/phc-winner-argon2">Argon2</a>
105+
is more appropriate for password hashing.
106+
</td>
107+
</tr>
108+
<tr>
109+
<td><a
110+
href="apidocs/org/apache/commons/codec/digest/Crypt.html">Crypt</a>
111+
</td>
112+
<td>GNU libc crypt(3) compatible hash method.</td>
113+
</tr>
114+
<tr>
115+
<td><a
116+
href="apidocs/org/apache/commons/codec/digest/DigestUtils.html">DigestUtils</a>
117+
</td>
118+
<td>Simplifies common <a
119+
href="https://docs.oracle.com/javase/6/docs/api/java/security/MessageDigest.html">MessageDigest</a>
120+
tasks and provides GNU libc crypt(3) compatible password hashing
121+
functions.
122+
</td>
123+
</tr>
124+
<tr>
125+
<td><a
126+
href="apidocs/org/apache/commons/codec/digest/HmacUtils.html">HmacUtils</a>
127+
</td>
128+
<td>Simplifies common <a
129+
href="https://docs.oracle.com/javase/6/docs/api/javax/crypto/Mac.html">Mac</a>
130+
tasks. <br /> <strong>Note:</strong> Not all JCE implementations
131+
support all algorithms. If not supported, an
132+
IllegalArgumentException is thrown.
133+
</td>
134+
</tr>
135+
<tr>
136+
<td><a
137+
href="apidocs/org/apache/commons/codec/digest/Md5Crypt.html">Md5Crypt</a>
138+
</td>
139+
<td>The libc crypt() "$1$" and Apache "$apr1$" MD5-based hash
140+
algorithm.</td>
141+
</tr>
142+
<tr>
143+
<td><a
144+
href="apidocs/org/apache/commons/codec/digest/MurmurHash1.html">MurmurHash1</a>
145+
</td>
146+
<td>Implementation of the MurmurHash1 32-bit and 64-bit hash
147+
functions.</td>
148+
</tr>
149+
<tr>
150+
<td><a
151+
href="apidocs/org/apache/commons/codec/digest/MurmurHash3.html">MurmurHash3</a>
152+
</td>
153+
<td>Implementation of the MurmurHash3 32-bit and 128-bit hash
154+
functions.</td>
155+
</tr>
156+
<tr>
157+
<td><a
158+
href="apidocs/org/apache/commons/codec/digest/PureJavaCrc32.html">PureJavaCrc32</a>
159+
</td>
160+
<td>A pure-java implementation of the CRC32 checksum that uses
161+
the same polynomial as the built-in native CRC32.</td>
162+
</tr>
163+
<tr>
164+
<td><a
165+
href="apidocs/org/apache/commons/codec/digest/PureJavaCrc32C.html">PureJavaCrc32C</a>
166+
</td>
167+
<td>A pure-java implementation of the CRC32 checksum that uses
168+
the CRC32-C polynomial, the same polynomial used by iSCSI and
169+
implemented on many Intel chipsets supporting SSE 4.2.</td>
170+
</tr>
171+
<tr>
172+
<td><a
173+
href="apidocs/org/apache/commons/codec/digest/Sha2Crypt.html">Sha2Crypt</a>
174+
</td>
175+
<td>SHA2-based Unix crypt implementation.</td>
176+
</tr>
177+
<tr>
178+
<td><a
179+
href="apidocs/org/apache/commons/codec/digest/UnixCrypt.html">UnixCrypt</a>
180+
</td>
181+
<td>Unix crypt(3) algorithm implementation. This class only
182+
implements the traditional 56 bit DES based algorithm.</td>
183+
</tr>
184+
<tr>
185+
<td><a
186+
href="apidocs/org/apache/commons/codec/digest/XXHash32.html">XXHash32</a>
187+
</td>
188+
<td>Implementation of the xxHash32 hash algorithm.</td>
189+
</tr>
190+
</table>
191+
</section>
192+
<section>
193+
<h1>Language Encoders</h1>
194+
<table>
195+
<caption>Language Encoders</caption>
196+
<tr>
197+
<td><a
198+
href="apidocs/org/apache/commons/codec/language/Caverphone1.html">Caverphone
199+
1.0 </a></td>
200+
<td>Encodes a string into a Caverphone 1.0 value.</td>
201+
</tr>
202+
<tr>
203+
<td><a
204+
href="apidocs/org/apache/commons/codec/language/Caverphone2.html">Caverphone
205+
2.0 </a></td>
206+
<td>Encodes a string into a Caverphone 2.0 value.</td>
207+
</tr>
208+
<tr>
209+
<td><a
210+
href="apidocs/org/apache/commons/codec/language/ColognePhonetic.html">Cologne
211+
Phonetic </a></td>
212+
<td>Encodes a string into a Cologne Phonetic value.</td>
213+
</tr>
214+
<tr>
215+
<td><a
216+
href="apidocs/org/apache/commons/codec/language/DoubleMetaphone.html">Double
217+
Metaphone </a></td>
218+
<td>Encodes a string into a double metaphone value.</td>
219+
</tr>
220+
<tr>
221+
<td><a
222+
href="apidocs/org/apache/commons/codec/language/Metaphone.html">Metaphone
223+
</a></td>
224+
<td>Encodes a string into a Metaphone value.</td>
225+
</tr>
226+
<tr>
227+
<td><a
228+
href="apidocs/org/apache/commons/codec/language/RefinedSoundex.html">Refined
229+
Soundex </a></td>
230+
<td>Encodes a string into a Refined Soundex value.</td>
231+
</tr>
232+
<tr>
233+
<td><a
234+
href="apidocs/org/apache/commons/codec/language/Soundex.html">Soundex
235+
</a></td>
236+
<td>Encodes a string into a Soundex value.</td>
237+
</tr>
238+
</table>
239+
</section>
240+
<section>
241+
<h1>Network Encoders</h1>
242+
<table>
243+
<caption>Network Encoders</caption>
244+
<tr>
245+
<td><a href="apidocs/org/apache/commons/codec/net/BCodec.html">
246+
BCodec </a></td>
247+
<td>Identical to the Base64 encoding defined by <a
248+
href="https://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> and allows
249+
a character set to be specified.
250+
</td>
251+
</tr>
252+
<tr>
253+
<td><a
254+
href="apidocs/org/apache/commons/codec/net/PercentCodec.html">
255+
PercentCodec </a></td>
256+
<td>Implements the Percent-Encoding scheme, as described in
257+
HTTP 1.1 specification.</td>
258+
</tr>
259+
<tr>
260+
<td><a href="apidocs/org/apache/commons/codec/net/QCodec.html">
261+
QCodec </a></td>
262+
<td>Similar to the Quoted-Printable content-transfer-encoding
263+
defined in <a href="https://www.ietf.org/rfc/rfc1521.txt">RFC
264+
1521</a> and designed to allow text containing mostly ASCII characters
265+
to be decipherable on an ASCII terminal without decoding.
266+
</td>
267+
</tr>
268+
<tr>
269+
<td><a
270+
href="apidocs/org/apache/commons/codec/net/QuotedPrintableCodec.html">
271+
QuotedPrintableCodec </a></td>
272+
<td>Codec for the Quoted-Printable section of <a
273+
href="https://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a> .
274+
</td>
275+
</tr>
276+
<tr>
277+
<td><a
278+
href="apidocs/org/apache/commons/codec/net/URLCodec.html">
279+
URLCodec </a></td>
280+
<td>Implements the <code>www-form-urlencoded</code> encoding
281+
scheme, also misleadingly known as URL encoding.
282+
</td>
283+
</tr>
284+
</table>
285+
</section>
286+
</body>
287+
</html>

‎src/site/site.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<item name="Javadoc Archive" href="https://javadoc.io/doc/commons-codec/commons-codec" />
4141
</item>
4242
<!-- End: For all components. -->
43-
<item name="Users guide" href="/userguide.html"/>
43+
<item name="Users guide" href="/apidocs/index.html"/>
4444
</menu>
4545
</body>
4646
</site>

0 commit comments

Comments
 (0)