com.caucho.web.webmail
Class MboxStream

java.lang.Object
  com.caucho.vfs.StreamImpl
      com.caucho.web.webmail.MboxStream

public class MboxStream
extends StreamImpl

Field Summary

Fields inherited from class com.caucho.vfs.StreamImpl

_nullPath, _path

Constructor Summary

MboxStream()

MboxStream(ReadStream is)

Method Summary

boolean	canRead() Returns true if this is a read stream.
java.lang.Object	getAttribute(java.lang.String key) Returns a read attribute from the multipart mime.
java.util.Iterator	getAttributeNames() Returns the headers from the mime.
java.lang.String	getEncoding() Returns the default encoding.
void	init(ReadStream is) Initialize the multipart stream with a given boundary.
ReadStream	openRead() Opens the next message of the mbox stream for reading.
int	read(byte[] buffer, int offset, int length) Reads from the multipart mime buffer.
void	setEncoding(java.lang.String encoding) Sets the default encoding.

Methods inherited from class com.caucho.vfs.StreamImpl

canWrite, clearWrite, close, closeWrite, flush, flushBuffer, flushToDisk, getAvailable, getFlushOnNewline, getNewline, getPath, getReadBuffer, getReadPosition, hasSkip, readNonBlock, readTimeout, removeAttribute, seekEnd, seekStart, setAttribute, setPath, setWriteEncoding, skip, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MboxStream

public MboxStream()
           throws java.io.IOException

Throws:

java.io.IOException

MboxStream

public MboxStream(ReadStream is)
           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getEncoding

public java.lang.String getEncoding()

Returns the default encoding.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the default encoding.

init

public void init(ReadStream is)
          throws java.io.IOException

Initialize the multipart stream with a given boundary. The boundary passed to init will have "--" prefixed.

Parameters:

is - the underlying stream

headerBoundary - the multipart/mime boundary.

Throws:

java.io.IOException

openRead

public ReadStream openRead()
                    throws java.io.IOException

Opens the next message of the mbox stream for reading. Returns null when the last message is read.

Throws:

java.io.IOException

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Returns a read attribute from the multipart mime.

Overrides:

getAttribute in class StreamImpl

Parameters:

key - the attribute name.

Returns:

the attribute value.

getAttributeNames

public java.util.Iterator getAttributeNames()

Returns the headers from the mime.

Overrides:

getAttributeNames in class StreamImpl

canRead

public boolean canRead()

Description copied from class: StreamImpl

Returns true if this is a read stream.

Overrides:

canRead in class StreamImpl

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws java.io.IOException

Reads from the multipart mime buffer.

Overrides:

read in class StreamImpl

Parameters:

buffer - byte array receiving the data.

offset - starting offset into the array.

length - number of bytes to read.

Returns:

the number of bytes read or -1 on end of file.

Throws:

java.io.IOException