Base64 (Java SE 13 & JDK 13 )
public class Base64 extends Object
This class consists exclusively of static methods for obtaining encoders and decoders for the Base64 encoding scheme. The implementation of this class supports the following types of Base64 as specified in RFC 4648 and RFC 2045.
- Basic
Uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for encoding and decoding operation. The encoder does not add any line feed (line separator) character. The decoder rejects data that contains characters outside the base64 alphabet.
- URL and Filename safe
Uses the "URL and Filename safe Base64 Alphabet" as specified in Table 2 of RFC 4648 for encoding and decoding. The encoder does not add any line feed (line separator) character. The decoder rejects data that contains characters outside the base64 alphabet.
- MIME
Uses "The Base64 Alphabet" as specified in Table 1 of RFC 2045 for encoding and decoding operation. The encoded output must be represented in lines of no more than 76 characters each and uses a carriage return
'\r'followed immediately by a linefeed'\n'as the line separator. No line separator is added to the end of the encoded output. All line separators or other characters not found in the base64 alphabet table are ignored in decoding operation.
Unless otherwise noted, passing a null argument to a
method of this class will cause a NullPointerException to be thrown.
- Since:
- 1.8
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBase64.DecoderThis class implements a decoder for decoding byte data using the Base64 encoding scheme as specified in RFC 4648 and RFC 2045.
static classBase64.EncoderThis class implements an encoder for encoding byte data using the Base64 encoding scheme as specified in RFC 4648 and RFC 2045.
-
Method Summary
-
Method Details
-
getEncoder
Returns a
Base64.Encoderthat encodes using the Basic type base64 encoding scheme.- Returns:
- A Base64 encoder.
-
getUrlEncoder
Returns a
Base64.Encoderthat encodes using the URL and Filename safe type base64 encoding scheme.- Returns:
- A Base64 encoder.
-
getMimeEncoder
Returns a
Base64.Encoderthat encodes using the MIME type base64 encoding scheme.- Returns:
- A Base64 encoder.
-
getMimeEncoder
public static Base64.Encoder getMimeEncoder(int lineLength, byte[] lineSeparator)
Returns a
Base64.Encoderthat encodes using the MIME type base64 encoding scheme with specified line length and line separators.- Parameters:
lineLength- the length of each output line (rounded down to nearest multiple of 4). If the rounded down line length is not a positive value, the output will not be separated in lineslineSeparator- the line separator for each output line- Returns:
- A Base64 encoder.
- Throws:
IllegalArgumentException- iflineSeparatorincludes any character of "The Base64 Alphabet" as specified in Table 1 of RFC 2045.
-
getDecoder
Returns a
Base64.Decoderthat decodes using the Basic type base64 encoding scheme.- Returns:
- A Base64 decoder.
-
getUrlDecoder
Returns a
Base64.Decoderthat decodes using the URL and Filename safe type base64 encoding scheme.- Returns:
- A Base64 decoder.
-
getMimeDecoder
Returns a
Base64.Decoderthat decodes using the MIME type base64 decoding scheme.- Returns:
- A Base64 decoder.
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.