diff --git a/docs/javadoc/2.12/allclasses-frame.html b/docs/javadoc/2.12/allclasses-frame.html
index d172140f7a..f8673798b8 100644
--- a/docs/javadoc/2.12/allclasses-frame.html
+++ b/docs/javadoc/2.12/allclasses-frame.html
@@ -2,10 +2,10 @@
-
+
All Classes (Jackson-core 2.12.0 API)
-
+
diff --git a/docs/javadoc/2.12/allclasses-noframe.html b/docs/javadoc/2.12/allclasses-noframe.html
index 8da3f1d107..76800af0c2 100644
--- a/docs/javadoc/2.12/allclasses-noframe.html
+++ b/docs/javadoc/2.12/allclasses-noframe.html
@@ -2,10 +2,10 @@
-
+
All Classes (Jackson-core 2.12.0 API)
-
+
diff --git a/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.PaddingReadBehaviour.html b/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.PaddingReadBehaviour.html
index 9934633572..3d07769f3e 100644
--- a/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.PaddingReadBehaviour.html
+++ b/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.PaddingReadBehaviour.html
@@ -2,10 +2,10 @@
-
+
Base64Variant.PaddingReadBehaviour (Jackson-core 2.12.0 API)
-
+
@@ -376,6 +376,6 @@ valueOf
-Copyright © 2008–2020 FasterXML . All rights reserved.
+Copyright © 2008–2021 FasterXML . All rights reserved.
diff --git a/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.html b/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.html
index 11b5a51701..1c1571b6c5 100644
--- a/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.html
+++ b/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variant.html
@@ -2,10 +2,10 @@
-
+
Base64Variant (Jackson-core 2.12.0 API)
-
+
@@ -326,7 +326,7 @@ Method Summary
int
encodeBase64Chunk (int b24,
byte[] buffer,
- int ptr)
+ int outPtr)
Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 bytes (ascii), stored in given result buffer.
@@ -335,7 +335,7 @@ Method Summary
int
encodeBase64Chunk (int b24,
char[] buffer,
- int ptr)
+ int outPtr)
Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 characters, stored in given result buffer.
@@ -558,6 +558,13 @@ Base64Variant
"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).
+
+Parameters:
+base
- Variant to use for settings not specific by other parameters
+name
- Name of this variant
+maxLineLength
- Maximum length (in characters) of lines to output before
+ using linefeed
+
@@ -574,6 +581,15 @@ Base64Variant
"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
+
+Parameters:
+base
- Variant to use for settings not specific by other parameters
+name
- Name of this variant
+writePadding
- Whether variant will use padding when encoding
+paddingChar
- Padding character used for encoding, excepted on reading, if any
+maxLineLength
- Maximum length (in characters) of lines to output before
+ using linefeed
+
@@ -704,6 +720,8 @@ usesPadding
requiresPaddingOnRead
public boolean requiresPaddingOnRead()
+Returns:
+True
if this variant requires padding on content decoded; false
if not.
Since:
2.12
@@ -717,6 +735,8 @@ requiresPaddingOnRead
acceptsPaddingOnRead
public boolean acceptsPaddingOnRead()
+Returns:
+True
if this variant accepts padding on content decoded; false
if not.
Since:
2.12
@@ -751,6 +771,8 @@ paddingReadBehaviour
Returns:
Indicator on how this Base64 encoding will handle possible padding
in content when reading.
+Since:
+2.12
@@ -789,6 +811,8 @@ getMaxLineLength
decodeBase64Char
public int decodeBase64Char(char c)
+Parameters:
+c
- Character to decode
Returns:
6-bit decoded value, if valid character;
@@ -829,9 +853,19 @@ encodeBase64BitsAsChar
encodeBase64Chunk
public int encodeBase64Chunk(int b24,
char[] buffer,
- int ptr)
+ int outPtr)
Method that encodes given right-aligned (LSB) 24-bit value
- into 4 base64 characters, stored in given result buffer.
+ into 4 base64 characters, stored in given result buffer.
+ Caller must ensure there is sufficient space for 4 encoded characters
+ at specified position.
+
+Parameters:
+b24
- 3-byte value to encode
+buffer
- Output buffer to append characters to
+outPtr
- Starting position within buffer
to append encoded characters
+Returns:
+Pointer in output buffer after appending 4 encoded characters
+
@@ -860,7 +894,12 @@ encodeBase64Partial
(LSB) of int.
Parameters:
-outputBytes
- Number of encoded bytes included (either 1 or 2)
+bits
- 24-bit chunk containing 1 or 2 bytes to encode
+outputBytes
- Number of input bytes to encode (either 1 or 2)
+buffer
- Output buffer to append characters to
+outPtr
- Starting position within buffer
to append encoded characters
+Returns:
+Pointer in output buffer after appending encoded characters (2, 3 or 4)
@@ -892,9 +931,17 @@ encodeBase64BitsAsByte
encodeBase64Chunk
public int encodeBase64Chunk(int b24,
byte[] buffer,
- int ptr)
+ int outPtr)
Method that encodes given right-aligned (LSB) 24-bit value
into 4 base64 bytes (ascii), stored in given result buffer.
+
+Parameters:
+b24
- 3-byte value to encode
+buffer
- Output buffer to append characters (as bytes) to
+outPtr
- Starting position within buffer
to append encoded characters
+Returns:
+Pointer in output buffer after appending 4 encoded characters
+
@@ -913,7 +960,12 @@ encodeBase64Partial
(LSB) of int.
Parameters:
-outputBytes
- Number of encoded bytes included (either 1 or 2)
+bits
- 24-bit chunk containing 1 or 2 bytes to encode
+outputBytes
- Number of input bytes to encode (either 1 or 2)
+buffer
- Output buffer to append characters to
+outPtr
- Starting position within buffer
to append encoded characters
+Returns:
+Pointer in output buffer after appending encoded characters (2, 3 or 4)
@@ -930,6 +982,8 @@ encode
Parameters:
input
- Byte array to encode
+Returns:
+Base64 encoded String of encoded input
bytes, not surrounded by quotes
@@ -949,6 +1003,9 @@ encode
Parameters:
input
- Byte array to encode
addQuotes
- Whether to surround resulting value in double quotes or not
+Returns:
+Base64 encoded String of encoded input
bytes, possibly
+ surrounded by quotes (if addQuotes
enabled)
@@ -968,6 +1025,9 @@ encode
Parameters:
input
- Byte array to encode
addQuotes
- Whether to surround resulting value in double quotes or not
+linefeed
- Linefeed to use for encoded content
+Returns:
+Base64 encoded String of encoded input
bytes
Since:
2.10
@@ -985,7 +1045,9 @@ decode
using this variant's settings.
Parameters:
-input
-
+input
- Base64-encoded input String to decode
+Returns:
+Byte array of decoded contents
Throws:
IllegalArgumentException
- if input is not valid base64 encoded data
Since:
@@ -1010,6 +1072,9 @@ decode
assumption is that caller will ensure it is given in proper state, and
used as appropriate afterwards.
+Parameters:
+str
- Input to decode
+builder
- Builder used for assembling decoded content
Throws:
IllegalArgumentException
- if input is not valid base64 encoded data
Since:
@@ -1068,8 +1133,10 @@ _reportInvalidBase64
throws IllegalArgumentException
Parameters:
+ch
- Character to report on
bindex
- Relative index within base64 character unit; between 0
and 3 (as unit has exactly 4 characters)
+msg
- Base message to use for exception
Throws:
IllegalArgumentException
@@ -1113,6 +1180,8 @@ unexpectedPaddingMessage
Helper method that will construct a message to use in exceptions for cases where input ends
prematurely in place where padding is not expected.
+Returns:
+Exception message for indicating "unexpected padding" case
Since:
2.12
@@ -1128,6 +1197,8 @@ missingPaddingMessage
Helper method that will construct a message to use in exceptions for cases where input ends
prematurely in place where padding would be expected.
+Returns:
+Exception message for indicating "missing padding" case
Since:
2.10
@@ -1202,6 +1273,6 @@ missingPaddingMessage
-Copyright © 2008–2020 FasterXML . All rights reserved.
+Copyright © 2008–2021 FasterXML . All rights reserved.
diff --git a/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variants.html b/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variants.html
index 5de77338c5..4dc69c1b3c 100644
--- a/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variants.html
+++ b/docs/javadoc/2.12/com/fasterxml/jackson/core/Base64Variants.html
@@ -2,10 +2,10 @@
-
+
Base64Variants (Jackson-core 2.12.0 API)
-
+
@@ -354,6 +354,10 @@ getDefaultVariant
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.
+
+Returns:
+Default variant (MIME_NO_LINEFEEDS
)
+
@@ -368,10 +372,12 @@ valueOf
If name does not match any of standard variant names,
a IllegalArgumentException
is thrown.
+Parameters:
+name
- Name of base64 variant to return
+Returns:
+Standard base64 variant that matches given name
Throws:
-IllegalArgumentException
-Since:
-2.1
+IllegalArgumentException
- if no standard variant with given name exists
@@ -444,6 +450,6 @@ valueOf
-Copyright © 2008–2020 FasterXML . All rights reserved.
+Copyright © 2008–2021 FasterXML . All rights reserved.