Base64

Kotlin |Java

open class Base64

kotlin.Any
↳	android.util.Base64

Utilities for encoding and decoding the Base64 representation of binary data. See RFCs 2045 and 3548.

Summary

Constants
static Int	`CRLF` Encoder flag bit to indicate lines should be terminated with a CRLF pair instead of just an LF.
static Int	`DEFAULT` Default values for encoder/decoder flags.
static Int	`NO_CLOSE` Flag to pass to `Base64OutputStream` to indicate that it should not close the output stream it is wrapping when it itself is closed.
static Int	`NO_PADDING` Encoder flag bit to omit the padding '=' characters at the end of the output (if any).
static Int	`NO_WRAP` Encoder flag bit to omit all line terminators (i.e., the output will be on one long line).
static Int	`URL_SAFE` Encoder/decoder flag bit to indicate using the "URL and filename safe" variant of Base64 (see RFC 3548 section 4) where `-` and `_` are used in place of `+` and `/`.

Public methods
open static ByteArray!	`decode(str: String!, flags: Int)` Decode the Base64-encoded data in input and return the data in a new byte array.
open static ByteArray!	`decode(input: ByteArray!, flags: Int)` Decode the Base64-encoded data in input and return the data in a new byte array.
open static ByteArray!	`decode(input: ByteArray!, offset: Int, len: Int, flags: Int)` Decode the Base64-encoded data in input and return the data in a new byte array.
open static ByteArray!	`encode(input: ByteArray!, flags: Int)` Base64-encode the given data and return a newly allocated byte[] with the result.
open static ByteArray!	`encode(input: ByteArray!, offset: Int, len: Int, flags: Int)` Base64-encode the given data and return a newly allocated byte[] with the result.
open static String!	`encodeToString(input: ByteArray!, flags: Int)` Base64-encode the given data and return a newly allocated String with the result.
open static String!	`encodeToString(input: ByteArray!, offset: Int, len: Int, flags: Int)` Base64-encode the given data and return a newly allocated String with the result.

Constants

CRLF

Added in API level 8

static val CRLF: Int

Encoder flag bit to indicate lines should be terminated with a CRLF pair instead of just an LF. Has no effect if NO_WRAP is specified as well.

Value: 4

DEFAULT

Added in API level 8

static val DEFAULT: Int

Default values for encoder/decoder flags.

Value: 0

NO_CLOSE

Added in API level 8

static val NO_CLOSE: Int

Flag to pass to Base64OutputStream to indicate that it should not close the output stream it is wrapping when it itself is closed.

Value: 16

NO_PADDING

Added in API level 8

static val NO_PADDING: Int

Encoder flag bit to omit the padding '=' characters at the end of the output (if any).

Value: 1

NO_WRAP

Added in API level 8

static val NO_WRAP: Int

Encoder flag bit to omit all line terminators (i.e., the output will be on one long line).

Value: 2

URL_SAFE

Added in API level 8

static val URL_SAFE: Int

Encoder/decoder flag bit to indicate using the "URL and filename safe" variant of Base64 (see RFC 3548 section 4) where - and _ are used in place of + and /.

Value: 8

Public methods

decode

Added in API level 8

open static fun decode(
    str: String!, 
    flags: Int
): ByteArray!

Decode the Base64-encoded data in input and return the data in a new byte array.

The padding '=' characters at the end are considered optional, but if any are present, there must be the correct number of them.

Parameters
`str`	String!: the input String to decode, which is converted to bytes using the default charset
`flags`	Int: controls certain features of the decoded output. Pass `DEFAULT` to decode standard Base64.

Exceptions
`java.lang.IllegalArgumentException`	if the input contains incorrect padding

decode

Added in API level 8

open static fun decode(
    input: ByteArray!, 
    flags: Int
): ByteArray!

Decode the Base64-encoded data in input and return the data in a new byte array.

The padding '=' characters at the end are considered optional, but if any are present, there must be the correct number of them.

Parameters
`input`	ByteArray!: the input array to decode
`flags`	Int: controls certain features of the decoded output. Pass `DEFAULT` to decode standard Base64.

Exceptions
`java.lang.IllegalArgumentException`	if the input contains incorrect padding

decode

Added in API level 8

open static fun decode(
    input: ByteArray!, 
    offset: Int, 
    len: Int, 
    flags: Int
): ByteArray!

Decode the Base64-encoded data in input and return the data in a new byte array.

The padding '=' characters at the end are considered optional, but if any are present, there must be the correct number of them.

Parameters
`input`	ByteArray!: the data to decode
`offset`	Int: the position within the input array at which to start
`len`	Int: the number of bytes of input to decode
`flags`	Int: controls certain features of the decoded output. Pass `DEFAULT` to decode standard Base64.

Exceptions
`java.lang.IllegalArgumentException`	if the input contains incorrect padding

encode

Added in API level 8

open static fun encode(
    input: ByteArray!, 
    flags: Int
): ByteArray!

Base64-encode the given data and return a newly allocated byte[] with the result.

Parameters
`input`	ByteArray!: the data to encode
`flags`	Int: controls certain features of the encoded output. Passing `DEFAULT` results in output that adheres to RFC 2045.

encode

Added in API level 8

open static fun encode(
    input: ByteArray!, 
    offset: Int, 
    len: Int, 
    flags: Int
): ByteArray!

Base64-encode the given data and return a newly allocated byte[] with the result.

Parameters
`input`	ByteArray!: the data to encode
`offset`	Int: the position within the input array at which to start
`len`	Int: the number of bytes of input to encode
`flags`	Int: controls certain features of the encoded output. Passing `DEFAULT` results in output that adheres to RFC 2045.

encodeToString

Added in API level 8

open static fun encodeToString(
    input: ByteArray!, 
    flags: Int
): String!

Base64-encode the given data and return a newly allocated String with the result.

Parameters
`input`	ByteArray!: the data to encode
`flags`	Int: controls certain features of the encoded output. Passing `DEFAULT` results in output that adheres to RFC 2045.

encodeToString

Added in API level 8

open static fun encodeToString(
    input: ByteArray!, 
    offset: Int, 
    len: Int, 
    flags: Int
): String!

Base64-encode the given data and return a newly allocated String with the result.

Parameters
`input`	ByteArray!: the data to encode
`offset`	Int: the position within the input array at which to start
`len`	Int: the number of bytes of input to encode
`flags`	Int: controls certain features of the encoded output. Passing `DEFAULT` results in output that adheres to RFC 2045.