org.apache.james.mailbox.store.search

Class MessageSearcher

java.lang.Object

org.apache.james.mailbox.store.search.MessageSearcher

public class MessageSearcher
extends Object

Searches an email for content. This class should be safe for use by concurrent threads.

Constructor Summary

Constructors

Constructor and Description
MessageSearcher()
MessageSearcher(CharSequence searchContent, boolean isCaseInsensitive, boolean includeHeaders)

Method Summary

Methods

Modifier and Type	Method and Description
org.slf4j.Logger	getLogger()
CharSequence	getSearchContent() Gets the content to be searched for.
protected void	handle(Exception e)
boolean	isCaseInsensitive() Is this search case insensitive?
boolean	isFoundIn(InputStream input) Is getSearchContent() found in the given input?
boolean	isIncludeHeaders() Is the search to include headers?
void	setCaseInsensitive(boolean isCaseInsensitive) Sets whether the search should be case insensitive.
void	setIncludeHeaders(boolean includesHeaders) Sets whether the search should include headers.
void	setLogger(org.slf4j.Logger logger)
void	setSearchContent(CharSequence searchContent) Sets the content sought.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSearcher

public MessageSearcher()

MessageSearcher

public MessageSearcher(CharSequence searchContent,
               boolean isCaseInsensitive,
               boolean includeHeaders)

Method Detail

isIncludeHeaders

public boolean isIncludeHeaders()

Is the search to include headers?

Returns:

true if header values are included, false otherwise

setIncludeHeaders

public void setIncludeHeaders(boolean includesHeaders)

Sets whether the search should include headers.

Parameters:

includesHeaders - true if header values are included, false otherwise

isCaseInsensitive

public boolean isCaseInsensitive()

Is this search case insensitive?

Returns:

true if the search should be case insensitive, false otherwise

setCaseInsensitive

public void setCaseInsensitive(boolean isCaseInsensitive)

Sets whether the search should be case insensitive.

Parameters:

isCaseInsensitive - true for case insensitive searches, false otherwise

getSearchContent

public CharSequence getSearchContent()

Gets the content to be searched for.

Returns:

search content, initially null

setSearchContent

public void setSearchContent(CharSequence searchContent)

Sets the content sought.

Parameters:

searchContent - content sought

isFoundIn

public boolean isFoundIn(InputStream input)
                  throws IOException,
                         org.apache.james.mime4j.MimeException

Is getSearchContent() found in the given input?

Parameters:

input - InputStream containing an email

Returns:

true if the content exists and the stream contains the content, false otherwise

Throws:

IOException

org.apache.james.mime4j.MimeException

handle

protected void handle(Exception e)
               throws IOException,
                      org.apache.james.mime4j.MimeException

Throws:

IOException

org.apache.james.mime4j.MimeException

getLogger

public final org.slf4j.Logger getLogger()

setLogger

public final void setLogger(org.slf4j.Logger logger)