Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d2affae1 authored by Doug Zongker's avatar Doug Zongker
Browse files

add a Base64 implementation to the API 

b/1413917 - RFE: Base64 utility class
Change-Id: I11697859e1f78f596b92d2e03a49ed1be04ae42d
parent 190dd57f

api/current.xml

+265 −0
Original line number Original line Diff line number Diff line
@@ -163525,6 +163525,271 @@ 
</method>

</method>

</class>

</class>

</package>

</package>

<package name="android.util.base64"

>

<class name="Base64"

 extends="java.lang.Object"

 abstract="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<method name="decode"

 return="byte[]"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="str" type="java.lang.String">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<method name="decode"

 return="byte[]"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="input" type="byte[]">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<method name="decode"

 return="byte[]"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="input" type="byte[]">

</parameter>

<parameter name="offset" type="int">

</parameter>

<parameter name="len" type="int">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<method name="encode"

 return="byte[]"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="input" type="byte[]">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<method name="encode"

 return="byte[]"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="input" type="byte[]">

</parameter>

<parameter name="offset" type="int">

</parameter>

<parameter name="len" type="int">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<method name="encodeToString"

 return="java.lang.String"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="input" type="byte[]">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<method name="encodeToString"

 return="java.lang.String"

 abstract="false"

 native="false"

 synchronized="false"

 static="true"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="input" type="byte[]">

</parameter>

<parameter name="offset" type="int">

</parameter>

<parameter name="len" type="int">

</parameter>

<parameter name="flags" type="int">

</parameter>

</method>

<field name="CRLF"

 type="int"

 transient="false"

 volatile="false"

 value="4"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="DEFAULT"

 type="int"

 transient="false"

 volatile="false"

 value="0"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="NO_CLOSE"

 type="int"

 transient="false"

 volatile="false"

 value="16"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="NO_PADDING"

 type="int"

 transient="false"

 volatile="false"

 value="1"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="NO_WRAP"

 type="int"

 transient="false"

 volatile="false"

 value="2"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

<field name="WEB_SAFE"

 type="int"

 transient="false"

 volatile="false"

 value="8"

 static="true"

 final="true"

 deprecated="not deprecated"

 visibility="public"

>

</field>

</class>

<class name="Base64InputStream"

 extends="java.io.FilterInputStream"

 abstract="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<constructor name="Base64InputStream"

 type="android.util.base64.Base64InputStream"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="in" type="java.io.InputStream">

</parameter>

<parameter name="flags" type="int">

</parameter>

</constructor>

<constructor name="Base64InputStream"

 type="android.util.base64.Base64InputStream"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="in" type="java.io.InputStream">

</parameter>

<parameter name="flags" type="int">

</parameter>

<parameter name="encode" type="boolean">

</parameter>

</constructor>

</class>

<class name="Base64OutputStream"

 extends="java.io.FilterOutputStream"

 abstract="false"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<constructor name="Base64OutputStream"

 type="android.util.base64.Base64OutputStream"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="out" type="java.io.OutputStream">

</parameter>

<parameter name="flags" type="int">

</parameter>

</constructor>

<constructor name="Base64OutputStream"

 type="android.util.base64.Base64OutputStream"

 static="false"

 final="false"

 deprecated="not deprecated"

 visibility="public"

>

<parameter name="out" type="java.io.OutputStream">

</parameter>

<parameter name="flags" type="int">

</parameter>

<parameter name="encode" type="boolean">

</parameter>

</constructor>

</class>

</package>

<package name="android.view"

<package name="android.view"

>

>

<class name="AbsSavedState"

<class name="AbsSavedState"

core/java/android/util/base64/Base64.java

0 → 100644
+706 −0

File added.

Preview size limit exceeded, changes collapsed.

core/java/android/util/base64/Base64InputStream.java

0 → 100644
+169 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2010 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.util.base64;



import java.io.FilterInputStream;

import java.io.IOException;

import java.io.InputStream;



/**

 * An OutputStream that does either Base64 encoding or decoding on the

 * data written to it, writing the resulting data to another

 * OutputStream.

 */

public class Base64InputStream extends FilterInputStream {

    private final boolean encode;

    private final Base64.EncoderState estate;

    private final Base64.DecoderState dstate;



    private static byte[] EMPTY = new byte[0];



    private static final int BUFFER_SIZE = 2048;

    private boolean eof;

    private byte[] inputBuffer;

    private byte[] outputBuffer;

    private int outputStart;

    private int outputEnd;



    /**

     * An InputStream that performs Base64 decoding on the data read

     * from the wrapped stream.

     *

     * @param in the InputStream to read the source data from

     * @param flags bit flags for controlling the decoder; see the

     *        constants in {@link Base64}

     */

    public Base64InputStream(InputStream in, int flags) {

        this(in, flags, false);

    }



    /**

     * Performs Base64 encoding or decoding on the data read from the

     * wrapped InputStream.

     *

     * @param in the InputStream to read the source data from

     * @param flags bit flags for controlling the decoder; see the

     *        constants in {@link Base64}

     * @param encode true to encode, false to decode

     */

    public Base64InputStream(InputStream in, int flags, boolean encode) {

        super(in);

        this.encode = encode;

        eof = false;

        inputBuffer = new byte[BUFFER_SIZE];

        if (encode) {

            // len*8/5+10 is an overestimate of the most bytes the

            // encoder can produce for len bytes of input.

            outputBuffer = new byte[BUFFER_SIZE * 8/5 + 10];

            estate = new Base64.EncoderState(flags, outputBuffer);

            dstate = null;

        } else {

            // len*3/4+10 is an overestimate of the most bytes the

            // decoder can produce for len bytes of input.

            outputBuffer = new byte[BUFFER_SIZE * 3/4 + 10];

            estate = null;

            dstate = new Base64.DecoderState(flags, outputBuffer);

        }

        outputStart = 0;

        outputEnd = 0;

    }



    public boolean markSupported() {

        return false;

    }



    public void mark(int readlimit) {

        throw new UnsupportedOperationException();

    }



    public void reset() {

        throw new UnsupportedOperationException();

    }



    public void close() throws IOException {

        in.close();

        inputBuffer = null;

    }



    public int available() {

        return outputEnd - outputStart;

    }



    public long skip(long n) throws IOException {

        if (outputStart >= outputEnd) {

            refill();

        }

        if (outputStart >= outputEnd) {

            return 0;

        }

        long bytes = Math.min(n, outputEnd-outputStart);

        outputStart += bytes;

        return bytes;

    }



    public int read() throws IOException {

        if (outputStart >= outputEnd) {

            refill();

        }

        if (outputStart >= outputEnd) {

            return -1;

        } else {

            return outputBuffer[outputStart++];

        }

    }



    public int read(byte[] b, int off, int len) throws IOException {

        if (outputStart >= outputEnd) {

            refill();

        }

        if (outputStart >= outputEnd) {

            return -1;

        }

        int bytes = Math.min(len, outputEnd-outputStart);

        System.arraycopy(outputBuffer, outputStart, b, off, bytes);

        outputStart += bytes;

        return bytes;

    }



    /**

     * Read data from the input stream into inputBuffer, then

     * decode/encode it into the empty outputBuffer, and reset the

     * outputStart and outputEnd pointers.

     */

    private void refill() throws IOException {

        if (eof) return;

        int bytesRead = in.read(inputBuffer);

        if (encode) {

            if (bytesRead == -1) {

                eof = true;

                Base64.encodeInternal(EMPTY, 0, 0, estate, true);

            } else {

                Base64.encodeInternal(inputBuffer, 0, bytesRead, estate, false);

            }

            outputEnd = estate.op;

        } else {

            if (bytesRead == -1) {

                eof = true;

                Base64.decodeInternal(EMPTY, 0, 0, dstate, true);

            } else {

                Base64.decodeInternal(inputBuffer, 0, bytesRead, dstate, false);

            }

            outputEnd = dstate.op;

        }

        outputStart = 0;

    }

}

core/java/android/util/base64/Base64OutputStream.java

0 → 100644
+153 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2010 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.util.base64;



import java.io.FilterOutputStream;

import java.io.IOException;

import java.io.OutputStream;



/**

 * An OutputStream that does either Base64 encoding or decoding on the

 * data written to it, writing the resulting data to another

 * OutputStream.

 */

public class Base64OutputStream extends FilterOutputStream {

    private final boolean encode;

    private final Base64.EncoderState estate;

    private final Base64.DecoderState dstate;

    private final int flags;



    private byte[] buffer = null;

    private int bpos = 0;



    private static byte[] EMPTY = new byte[0];



    /**

     * Performs Base64 encoding on the data written to the stream,

     * writing the encoded data to another OutputStream.

     *

     * @param out the OutputStream to write the encoded data to

     * @param flags bit flags for controlling the encoder; see the

     *        constants in {@link Base64}

     */

    public Base64OutputStream(OutputStream out, int flags) {

        this(out, flags, true);

    }



    /**

     * Performs Base64 encoding or decoding on the data written to the

     * stream, writing the encoded/decoded data to another

     * OutputStream.

     *

     * @param out the OutputStream to write the encoded data to

     * @param flags bit flags for controlling the encoder; see the

     *        constants in {@link Base64}

     * @param encode true to encode, false to decode

     */

    public Base64OutputStream(OutputStream out, int flags, boolean encode) {

        super(out);

        this.flags = flags;

        this.encode = encode;

        if (encode) {

            estate = new Base64.EncoderState(flags, null);

            dstate = null;

        } else {

            estate = null;

            dstate = new Base64.DecoderState(flags, null);

        }

    }



    public void write(int b) throws IOException {

        // To avoid invoking the encoder/decoder routines for single

        // bytes, we buffer up calls to write(int) in an internal

        // byte array to transform them into writes of decently-sized

        // arrays.



        if (buffer == null) {

            buffer = new byte[1024];

        }

        if (bpos >= buffer.length) {

            // internal buffer full; write it out.

            internalWrite(buffer, 0, bpos, false);

            bpos = 0;

        }

        buffer[bpos++] = (byte) b;

    }



    /**

     * Flush any buffered data from calls to write(int).  Needed

     * before doing a write(byte[], int, int) or a close().

     */

    private void flushBuffer() throws IOException {

        if (bpos > 0) {

            internalWrite(buffer, 0, bpos, false);

            bpos = 0;

        }

    }



    public void write(byte[] b, int off, int len) throws IOException {

        if (len <= 0) return;

        flushBuffer();

        internalWrite(b, off, len, false);

    }



    public void close() throws IOException {

        flushBuffer();

        internalWrite(EMPTY, 0, 0, true);

        if ((flags & Base64.NO_CLOSE) == 0) {

            out.close();

        } else {

            out.flush();

        }

    }



    /**

     * Write the given bytes to the encoder/decoder.

     *

     * @param finish true if this is the last batch of input, to cause

     *        encoder/decoder state to be finalized.

     */

    private void internalWrite(byte[] b, int off, int len, boolean finish) throws IOException {

        if (encode) {

            // len*8/5+10 is an overestimate of the most bytes the

            // encoder can produce for len bytes of input.

            estate.output = embiggen(estate.output, len*8/5+10);

            Base64.encodeInternal(b, off, len, estate, finish);

            out.write(estate.output, 0, estate.op);

        } else {

            // len*3/4+10 is an overestimate of the most bytes the

            // decoder can produce for len bytes of input.

            dstate.output = embiggen(dstate.output, len*3/4+10);

            if (!Base64.decodeInternal(b, off, len, dstate, finish)) {

                throw new IOException("bad base-64");

            }

            out.write(dstate.output, 0, dstate.op);

        }

    }



    /**

     * If b.length is at least len, return b.  Otherwise return a new

     * byte array of length len.

     */

    private byte[] embiggen(byte[] b, int len) {

        if (b == null || b.length < len) {

            return new byte[len];

        } else {

            return b;

        }

    }

}

core/tests/coretests/src/android/util/base64/Base64Test.java

0 → 100644
+520 −0

File added.

Preview size limit exceeded, changes collapsed.