Skip to content

Commit

Permalink
Republish javadocs for 2.12 (lots of javadoc cleanup work before 2.12.1)
Browse files Browse the repository at this point in the history
  • Loading branch information
cowtowncoder committed Jan 9, 2021
1 parent 0137d84 commit 7f6c506
Show file tree
Hide file tree
Showing 293 changed files with 6,042 additions and 2,300 deletions.
4 changes: 2 additions & 2 deletions docs/javadoc/2.12/allclasses-frame.html
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Sat Nov 28 16:55:50 PST 2020 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 08 17:16:37 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (Jackson-core 2.12.0 API)</title>
<meta name="date" content="2020-11-28">
<meta name="date" content="2021-01-08">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/javadoc/2.12/allclasses-noframe.html
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Sat Nov 28 16:55:50 PST 2020 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 08 17:16:37 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (Jackson-core 2.12.0 API)</title>
<meta name="date" content="2020-11-28">
<meta name="date" content="2021-01-08">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Sat Nov 28 16:55:49 PST 2020 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 08 17:16:35 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base64Variant.PaddingReadBehaviour (Jackson-core 2.12.0 API)</title>
<meta name="date" content="2020-11-28">
<meta name="date" content="2021-01-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -376,6 +376,6 @@ <h4>valueOf</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
</body>
</html>
93 changes: 82 additions & 11 deletions docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.html
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Sat Nov 28 16:55:49 PST 2020 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 08 17:16:35 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base64Variant (Jackson-core 2.12.0 API)</title>
<meta name="date" content="2020-11-28">
<meta name="date" content="2021-01-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -326,7 +326,7 @@ <h3>Method Summary</h3>
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/core/Base64Variant.html#encodeBase64Chunk-int-byte:A-int-">encodeBase64Chunk</a></span>(int&nbsp;b24,
byte[]&nbsp;buffer,
int&nbsp;ptr)</code>
int&nbsp;outPtr)</code>
<div class="block">Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 bytes (ascii), stored in given result buffer.</div>
</td>
Expand All @@ -335,7 +335,7 @@ <h3>Method Summary</h3>
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/core/Base64Variant.html#encodeBase64Chunk-int-char:A-int-">encodeBase64Chunk</a></span>(int&nbsp;b24,
char[]&nbsp;buffer,
int&nbsp;ptr)</code>
int&nbsp;outPtr)</code>
<div class="block">Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 characters, stored in given result buffer.</div>
</td>
Expand Down Expand Up @@ -558,6 +558,13 @@ <h4>Base64Variant</h4>
<div class="block">"Copy constructor" that can be used when the base alphabet is identical
to one used by another variant except for the maximum line length
(and obviously, name).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>base</code> - Variant to use for settings not specific by other parameters</dd>
<dd><code>name</code> - Name of this variant</dd>
<dd><code>maxLineLength</code> - Maximum length (in characters) of lines to output before
using linefeed</dd>
</dl>
</li>
</ul>
<a name="Base64Variant-com.fasterxml.jackson.core.Base64Variant-java.lang.String-boolean-char-int-">
Expand All @@ -574,6 +581,15 @@ <h4>Base64Variant</h4>
<div class="block">"Copy constructor" that can be used when the base alphabet is identical
to one used by another variant, but other details (padding, maximum
line length) differ</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>base</code> - Variant to use for settings not specific by other parameters</dd>
<dd><code>name</code> - Name of this variant</dd>
<dd><code>writePadding</code> - Whether variant will use padding when encoding</dd>
<dd><code>paddingChar</code> - Padding character used for encoding, excepted on reading, if any</dd>
<dd><code>maxLineLength</code> - Maximum length (in characters) of lines to output before
using linefeed</dd>
</dl>
</li>
</ul>
</li>
Expand Down Expand Up @@ -704,6 +720,8 @@ <h4>usesPadding</h4>
<h4>requiresPaddingOnRead</h4>
<pre>public&nbsp;boolean&nbsp;requiresPaddingOnRead()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if this variant requires padding on content decoded; <code>false</code> if not.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.12</dd>
</dl>
Expand All @@ -717,6 +735,8 @@ <h4>requiresPaddingOnRead</h4>
<h4>acceptsPaddingOnRead</h4>
<pre>public&nbsp;boolean&nbsp;acceptsPaddingOnRead()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>True</code> if this variant accepts padding on content decoded; <code>false</code> if not.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.12</dd>
</dl>
Expand Down Expand Up @@ -751,6 +771,8 @@ <h4>paddingReadBehaviour</h4>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Indicator on how this Base64 encoding will handle possible padding
in content when reading.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.12</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -789,6 +811,8 @@ <h4>getMaxLineLength</h4>
<h4>decodeBase64Char</h4>
<pre>public&nbsp;int&nbsp;decodeBase64Char(char&nbsp;c)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - Character to decode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>6-bit decoded value, if valid character;</dd>
</dl>
Expand Down Expand Up @@ -829,9 +853,19 @@ <h4>encodeBase64BitsAsChar</h4>
<h4>encodeBase64Chunk</h4>
<pre>public&nbsp;int&nbsp;encodeBase64Chunk(int&nbsp;b24,
char[]&nbsp;buffer,
int&nbsp;ptr)</pre>
int&nbsp;outPtr)</pre>
<div class="block">Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 characters, stored in given result buffer.</div>
into 4 base64 characters, stored in given result buffer.
Caller must ensure there is sufficient space for 4 encoded characters
at specified position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b24</code> - 3-byte value to encode</dd>
<dd><code>buffer</code> - Output buffer to append characters to</dd>
<dd><code>outPtr</code> - Starting position within <code>buffer</code> to append encoded characters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Pointer in output buffer after appending 4 encoded characters</dd>
</dl>
</li>
</ul>
<a name="encodeBase64Chunk-java.lang.StringBuilder-int-">
Expand Down Expand Up @@ -860,7 +894,12 @@ <h4>encodeBase64Partial</h4>
(LSB) of int.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputBytes</code> - Number of encoded bytes included (either 1 or 2)</dd>
<dd><code>bits</code> - 24-bit chunk containing 1 or 2 bytes to encode</dd>
<dd><code>outputBytes</code> - Number of input bytes to encode (either 1 or 2)</dd>
<dd><code>buffer</code> - Output buffer to append characters to</dd>
<dd><code>outPtr</code> - Starting position within <code>buffer</code> to append encoded characters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Pointer in output buffer after appending encoded characters (2, 3 or 4)</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -892,9 +931,17 @@ <h4>encodeBase64BitsAsByte</h4>
<h4>encodeBase64Chunk</h4>
<pre>public&nbsp;int&nbsp;encodeBase64Chunk(int&nbsp;b24,
byte[]&nbsp;buffer,
int&nbsp;ptr)</pre>
int&nbsp;outPtr)</pre>
<div class="block">Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 bytes (ascii), stored in given result buffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b24</code> - 3-byte value to encode</dd>
<dd><code>buffer</code> - Output buffer to append characters (as bytes) to</dd>
<dd><code>outPtr</code> - Starting position within <code>buffer</code> to append encoded characters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Pointer in output buffer after appending 4 encoded characters</dd>
</dl>
</li>
</ul>
<a name="encodeBase64Partial-int-int-byte:A-int-">
Expand All @@ -913,7 +960,12 @@ <h4>encodeBase64Partial</h4>
(LSB) of int.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputBytes</code> - Number of encoded bytes included (either 1 or 2)</dd>
<dd><code>bits</code> - 24-bit chunk containing 1 or 2 bytes to encode</dd>
<dd><code>outputBytes</code> - Number of input bytes to encode (either 1 or 2)</dd>
<dd><code>buffer</code> - Output buffer to append characters to</dd>
<dd><code>outPtr</code> - Starting position within <code>buffer</code> to append encoded characters</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Pointer in output buffer after appending encoded characters (2, 3 or 4)</dd>
</dl>
</li>
</ul>
Expand All @@ -930,6 +982,8 @@ <h4>encode</h4>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - Byte array to encode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Base64 encoded String of encoded <code>input</code> bytes, not surrounded by quotes</dd>
</dl>
</li>
</ul>
Expand All @@ -949,6 +1003,9 @@ <h4>encode</h4>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - Byte array to encode</dd>
<dd><code>addQuotes</code> - Whether to surround resulting value in double quotes or not</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Base64 encoded String of encoded <code>input</code> bytes, possibly
surrounded by quotes (if <code>addQuotes</code> enabled)</dd>
</dl>
</li>
</ul>
Expand All @@ -968,6 +1025,9 @@ <h4>encode</h4>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - Byte array to encode</dd>
<dd><code>addQuotes</code> - Whether to surround resulting value in double quotes or not</dd>
<dd><code>linefeed</code> - Linefeed to use for encoded content</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Base64 encoded String of encoded <code>input</code> bytes</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.10</dd>
</dl>
Expand All @@ -985,7 +1045,9 @@ <h4>decode</h4>
using this variant's settings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - </dd>
<dd><code>input</code> - Base64-encoded input String to decode</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Byte array of decoded contents</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input is not valid base64 encoded data</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
Expand All @@ -1010,6 +1072,9 @@ <h4>decode</h4>
assumption is that caller will ensure it is given in proper state, and
used as appropriate afterwards.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>str</code> - Input to decode</dd>
<dd><code>builder</code> - Builder used for assembling decoded content</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if input is not valid base64 encoded data</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
Expand Down Expand Up @@ -1068,8 +1133,10 @@ <h4>_reportInvalidBase64</h4>
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ch</code> - Character to report on</dd>
<dd><code>bindex</code> - Relative index within base64 character unit; between 0
and 3 (as unit has exactly 4 characters)</dd>
<dd><code>msg</code> - Base message to use for exception</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd>
</dl>
Expand Down Expand Up @@ -1113,6 +1180,8 @@ <h4>unexpectedPaddingMessage</h4>
<div class="block">Helper method that will construct a message to use in exceptions for cases where input ends
prematurely in place where padding is not expected.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Exception message for indicating "unexpected padding" case</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.12</dd>
</dl>
Expand All @@ -1128,6 +1197,8 @@ <h4>missingPaddingMessage</h4>
<div class="block">Helper method that will construct a message to use in exceptions for cases where input ends
prematurely in place where padding would be expected.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Exception message for indicating "missing padding" case</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.10</dd>
</dl>
Expand Down Expand Up @@ -1202,6 +1273,6 @@ <h4>missingPaddingMessage</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
</body>
</html>
18 changes: 12 additions & 6 deletions docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variants.html
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Sat Nov 28 16:55:49 PST 2020 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 08 17:16:35 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base64Variants (Jackson-core 2.12.0 API)</title>
<meta name="date" content="2020-11-28">
<meta name="date" content="2021-01-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -354,6 +354,10 @@ <h4>getDefaultVariant</h4>
where caller does not explicitly specify the variant.
We will prefer no-linefeed version because linefeeds in JSON values
must be escaped, making linefeed-containing variants sub-optimal.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Default variant (<code>MIME_NO_LINEFEEDS</code>)</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
Expand All @@ -368,10 +372,12 @@ <h4>valueOf</h4>
If name does not match any of standard variant names,
a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> is thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of base64 variant to return</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Standard base64 variant that matches given <code>name</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if no standard variant with given name exists</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -444,6 +450,6 @@ <h4>valueOf</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
</body>
</html>
14 changes: 11 additions & 3 deletions docs/javadoc/2.12/com/fasterxml/jackson/core/FormatFeature.html
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_272) on Sat Nov 28 16:55:49 PST 2020 -->
<!-- Generated by javadoc (1.8.0_272) on Fri Jan 08 17:16:35 PST 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FormatFeature (Jackson-core 2.12.0 API)</title>
<meta name="date" content="2020-11-28">
<meta name="date" content="2021-01-08">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -186,6 +186,8 @@ <h4>enabledByDefault</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html#enabledByDefault--">enabledByDefault</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether this instance is enabled by default or not</dd>
</dl>
</li>
</ul>
Expand All @@ -201,6 +203,8 @@ <h4>getMask</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html#getMask--">getMask</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Bit mask of this feature</dd>
</dl>
</li>
</ul>
Expand All @@ -215,6 +219,10 @@ <h4>enabledIn</h4>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html#enabledIn-int-">enabledIn</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>flags</code> - Bit field that contains a set of enabled features of this type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if this feature is enabled in passed bit field</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -287,6 +295,6 @@ <h4>enabledIn</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
</body>
</html>

0 comments on commit 7f6c506

Please sign in to comment.