gnu.java.io

Class Base64InputStream

Implemented Interfaces:
AutoCloseable, Closeable

public class Base64InputStream
extends FilterInputStream

A filter input stream that decodes data encoded in the Base-64 encoding scheme.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Base64InputStream(InputStream in)
Create a new Base-64 input stream.

Method Summary

int
available()
Calls the in.available() method.
static byte[]
decode(String base64)
Decode a single Base-64 string to a byte array.
void
mark(int markLimit)
Calls the in.mark(int) method.
boolean
markSupported()
Calls the in.markSupported() method.
int
read()
Calls the in.read() method
int
read(byte[] buf, int off, int len)
Calls the in.read(byte[], int, int) method.
void
reset()
Calls the in.reset() method.
long
skip(long n)
Calls the in.skip(long) method

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Base64InputStream

public Base64InputStream(InputStream in)
Create a new Base-64 input stream. The input bytes must be the ASCII characters A-Z, a-z, 0-9, + and /, with optional whitespace, and will be decoded into a byte stream.
Parameters:
in - The source of Base-64 input.

Method Details

available

public int available()
Calls the in.available() method.
Overrides:
available in interface FilterInputStream
Returns:
The value returned from in.available()

decode

public static byte[] decode(String base64)
            throws IOException
Decode a single Base-64 string to a byte array.
Parameters:
base64 - The Base-64 encoded data.
Returns:
The decoded bytes.
Throws:
IOException - If the given data do not compose a valid Base-64 sequence.

mark

public void mark(int markLimit)
Calls the in.mark(int) method.
Overrides:
mark in interface FilterInputStream
Parameters:

markSupported

public boolean markSupported()
Calls the in.markSupported() method.
Overrides:
markSupported in interface FilterInputStream
Returns:
true if mark/reset is supported, false otherwise

read

public int read()
            throws IOException
Calls the in.read() method
Overrides:
read in interface FilterInputStream
Returns:
The value returned from in.read()
Throws:
IOException - If an error occurs

read

public int read(byte[] buf,
                int off,
                int len)
            throws IOException
Calls the in.read(byte[], int, int) method.
Overrides:
read in interface FilterInputStream
Parameters:
buf - The buffer to read bytes into
len - The maximum number of bytes to read.
Returns:
The value retured from in.read(byte[], int, int)
Throws:
IOException - If an error occurs

reset

public void reset()
            throws IOException
Calls the in.reset() method.
Overrides:
reset in interface FilterInputStream
Throws:
IOException - If an error occurs

skip

public long skip(long n)
            throws IOException
Calls the in.skip(long) method
Overrides:
skip in interface FilterInputStream
Parameters:
Returns:
The value returned from in.skip(long)
Throws:
IOException - If an error occurs

Base64InputStream.java -- base-64 input stream. Copyright (C) 2003, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.