Class MboxIterator

java.lang.Object

org.apache.james.mime4j.mboxiterator.MboxIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<CharBufferWrapper>

public class MboxIterator
extends Object
implements Iterable<CharBufferWrapper>, Closeable

Class that provides an iterator over email messages inside an mbox file. An mbox file is a sequence of email messages separated by From_ lines.

Description ot the file format:

• http://tools.ietf.org/html/rfc4155
• http://qmail.org/man/man5/mbox.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MboxIterator.Builder
private class	MboxIterator.MessageIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer	byteBuffer
private final CharsetDecoder	DECODER
private boolean	endOfInputFlag	Flag to signal end of input to CharsetDecoder.decode(java.nio.ByteBuffer) .
private int	findEnd
private int	findStart
private boolean	fromLineFound
private Matcher	fromLineMatcher
private final int	maxMessageSize
private final Path	mbox
private final CharBuffer	mboxCharBuffer
private final Pattern	MESSAGE_START

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MboxIterator(Path mbox, Charset charset, String regexpPattern, int regexpFlags, int MAX_MESSAGE_SIZE)

Method Summary

Modifier and Type	Method	Description
static String	bufferDetailsToString(Buffer buffer)	Utility method to log important details about buffers.
void	close()
private void	decodeNextCharBuffer()
static MboxIterator.Builder	fromFile(File filePath)
static MboxIterator.Builder	fromFile(String file)
static MboxIterator.Builder	fromFile(Path filePath)
protected void	initMboxIterator()	initialize the Mailbox iterator
Iterator<CharBufferWrapper>	iterator()
private void	saveFindPositions(Matcher lineMatcher)
private void	updateEndOfInputFlag()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Details

mboxCharBuffer

private final CharBuffer mboxCharBuffer

fromLineMatcher

private Matcher fromLineMatcher

fromLineFound

private boolean fromLineFound

byteBuffer

private final ByteBuffer byteBuffer

DECODER

private final CharsetDecoder DECODER

endOfInputFlag

private boolean endOfInputFlag

Flag to signal end of input to CharsetDecoder.decode(java.nio.ByteBuffer) .

maxMessageSize

private final int maxMessageSize

MESSAGE_START

private final Pattern MESSAGE_START

findStart

private int findStart

findEnd

private int findEnd

mbox

private final Path mbox

Constructor Details

MboxIterator

private MboxIterator(Path mbox,
 Charset charset,
 String regexpPattern,
 int regexpFlags,
 int MAX_MESSAGE_SIZE)
              throws FileNotFoundException,
IOException,
CharConversionException

Throws:

FileNotFoundException

IOException

CharConversionException

Method Details

initMboxIterator

protected void initMboxIterator()
                         throws IOException

initialize the Mailbox iterator

Throws:

IOException

CharConversionException

decodeNextCharBuffer

private void decodeNextCharBuffer()
                           throws CharConversionException

Throws:

CharConversionException

updateEndOfInputFlag

private void updateEndOfInputFlag()

saveFindPositions

private void saveFindPositions(Matcher lineMatcher)

iterator

public Iterator<CharBufferWrapper> iterator()

Specified by:

iterator in interface Iterable<CharBufferWrapper>

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

fromFile

public static MboxIterator.Builder fromFile(Path filePath)

fromFile

public static MboxIterator.Builder fromFile(File filePath)

fromFile

public static MboxIterator.Builder fromFile(String file)

bufferDetailsToString

public static String bufferDetailsToString(Buffer buffer)

Utility method to log important details about buffers.

Parameters:

buffer -