Class Base64
- java.lang.Object
-
- java.util.Base64
-
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 "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
nullargument to a method of this class will cause aNullPointerExceptionto be thrown.- Since:
- 1.8
- Basic
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and 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
All Methods Static Methods Concrete Methods Modifier and Type Method and Description static Base64.DecodergetDecoder()Returns aBase64.Decoderthat decodes using the Basic type base64 encoding scheme.static Base64.EncodergetEncoder()Returns aBase64.Encoderthat encodes using the Basic type base64 encoding scheme.static Base64.DecodergetMimeDecoder()Returns aBase64.Decoderthat decodes using the MIME type base64 decoding scheme.static Base64.EncodergetMimeEncoder()Returns aBase64.Encoderthat encodes using the MIME type base64 encoding scheme.static Base64.EncodergetMimeEncoder(int lineLength, byte[] lineSeparator)Returns aBase64.Encoderthat encodes using the MIME type base64 encoding scheme with specified line length and line separators.static Base64.DecodergetUrlDecoder()Returns aBase64.Decoderthat decodes using the URL and Filename safe type base64 encoding scheme.static Base64.EncodergetUrlEncoder()Returns aBase64.Encoderthat encodes using the URL and Filename safe type base64 encoding scheme.
-
-
-
Method Detail
getEncoder
public static Base64.Encoder getEncoder()
Returns aBase64.Encoderthat encodes using the Basic type base64 encoding scheme.- Returns:
- A Base64 encoder.
getUrlEncoder
public static Base64.Encoder getUrlEncoder()
Returns aBase64.Encoderthat encodes using the URL and Filename safe type base64 encoding scheme.- Returns:
- A Base64 encoder.
getMimeEncoder
public static Base64.Encoder getMimeEncoder()
Returns aBase64.Encoderthat encodes using the MIME type base64 encoding scheme.- Returns:
- A Base64 encoder.
getMimeEncoder
public static Base64.Encoder getMimeEncoder(int lineLength, byte[] lineSeparator)
Returns aBase64.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). IflineLength <= 0the output will not be separated in lines -
lineSeparator- 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
public static Base64.Decoder getDecoder()
Returns aBase64.Decoderthat decodes using the Basic type base64 encoding scheme.- Returns:
- A Base64 decoder.
getUrlDecoder
public static Base64.Decoder getUrlDecoder()
Returns aBase64.Decoderthat decodes using the URL and Filename safe type base64 encoding scheme.- Returns:
- A Base64 decoder.
getMimeDecoder
public static Base64.Decoder getMimeDecoder()
Returns aBase64.Decoderthat decodes using the MIME type base64 decoding scheme.- Returns:
- A Base64 decoder.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
