org.ws4d.java.communication.protocol.http

Class Base64Util.InputStream

java.lang.Object

java.io.InputStream

org.ws4d.java.communication.protocol.http.Base64Util.InputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

Base64Util

public static class Base64Util.InputStream
extends java.io.InputStream

A Base64Util.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Since:

1.3

See Also:

Base64Util

Constructor Summary

Constructors

Constructor and Description
InputStream(java.io.InputStream in) Constructs a Base64Util.InputStream in DECODE mode.
InputStream(java.io.InputStream in, int options) Constructs a Base64Util.InputStream in either ENCODE or DECODE mode.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes that can be read from this input stream without blocking.
void	close() Closes this input stream and releases any system resources associated with the stream.
void	mark(int readlimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
int	read() Reads enough of the input stream to convert to/from Base64 and returns the next byte.
int	read(byte[] dest) Calls read() repeatedly until the end of stream is reached or len bytes have been read.
int	read(byte[] dest, int off, int len) Calls read() repeatedly until the end of stream is reached or len bytes have been read.
void	reset() Repositions this stream to the position at the time the mark method was last called on this input stream.

Methods inherited from class java.io.InputStream

skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputStream

public InputStream(java.io.InputStream in)

Constructs a Base64Util.InputStream in DECODE mode.

Parameters:

in - the java.io.InputStream from which to read data.

Since:

1.3

InputStream

public InputStream(java.io.InputStream in,
                   int options)

Constructs a Base64Util.InputStream in either ENCODE or DECODE mode.

Valid options:

    ENCODE or DECODE: Encode or Decode as data is read.
    DONT_BREAK_LINES: don't break lines at 76 characters
      (only meaningful when encoding)
      <i>Note: Technically, this makes your encoding non-compliant.</i>
 

Example: new Base64.InputStream( in, Base64.DECODE )

Parameters:

in - the java.io.InputStream from which to read data.

options - Specified options

Since:

2.0

See Also:

Base64Util.ENCODE, Base64Util.DECODE, Base64Util.DONT_BREAK_LINES

Method Detail

read

public int read()
         throws java.io.IOException

Reads enough of the input stream to convert to/from Base64 and returns the next byte.

Specified by:

read in class java.io.InputStream

Returns:

next byte

Throws:

java.io.IOException

Since:

1.3

read

public int read(byte[] dest,
                int off,
                int len)
         throws java.io.IOException

Calls read() repeatedly until the end of stream is reached or len bytes have been read. Returns number of bytes read into array or -1 if end of stream is encountered.

Overrides:

read in class java.io.InputStream

Parameters:

dest - array to hold values

off - offset for array

len - max number of bytes to read into array

Returns:

bytes read into array or -1 if end of stream is encountered.

Throws:

java.io.IOException

Since:

1.3

read

public int read(byte[] dest)
         throws java.io.IOException

Calls read() repeatedly until the end of stream is reached or len bytes have been read. Returns number of bytes read into array or -1 if end of stream is encountered.

Overrides:

read in class java.io.InputStream

Parameters:

dest - array to hold values

Returns:

bytes read into array or -1 if end of stream is encountered.

Throws:

java.io.IOException

Since:

3.0

available

public int available()
              throws java.io.IOException

Returns the number of bytes that can be read from this input stream without blocking.

Returns always 0.

Overrides:

available in class java.io.InputStream

Returns:

the number of bytes that can be read from the input stream without blocking.

Throws:

java.io.IOException

Since:

3.0

close

public void close()
           throws java.io.IOException

Closes this input stream and releases any system resources associated with the stream.

This method simply performs in.close(). *

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException

Since:

3.0

mark

public void mark(int readlimit)

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

This method simply performs in.mark(readlimit).

Overrides:

mark in class java.io.InputStream

Parameters:

readlimit - - the maximum limit of bytes that can be read before the mark position becomes invalid.

Since:

3.0

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods.

This method simply performs in.markSupported().

Overrides:

markSupported in class java.io.InputStream

Returns:

true if this stream type supports the mark and reset method; false otherwise.

Since:

3.0

reset

public void reset()
           throws java.io.IOException

Repositions this stream to the position at the time the mark method was last called on this input stream.

This method simply performs in.reset().

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should throw an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException

Since:

3.0