org.apache.james.mailbox.model.MessageResultIterator Maven / Gradle / Ivy
/****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one *
* or more contributor license agreements. See the NOTICE file *
* distributed with this work for additional information *
* regarding copyright ownership. The ASF licenses this file *
* to you under the Apache License, Version 2.0 (the *
* "License"); you may not use this file except in compliance *
* with the License. You may obtain a copy of the License at *
* *
* http://www.apache.org/licenses/LICENSE-2.0 *
* *
* Unless required by applicable law or agreed to in writing, *
* software distributed under the License is distributed on an *
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
* KIND, either express or implied. See the License for the *
* specific language governing permissions and limitations *
* under the License. *
****************************************************************/
package org.apache.james.mailbox.model;
import java.util.Iterator;
import org.apache.james.mailbox.exception.MailboxException;
/**
* A special {@link Iterator} which allows to access the {@link MailboxException} if one was thrown while try to lazy fetch the {@link MessageResult}'s in batches
*/
public interface MessageResultIterator extends Iterator {
/**
* This method should get called after the {@link #hasNext()} method returns
* false.
*
* If it does not return null an error was thrown before while
* try to lazy fetch th next batch of {@link MessageResult}'s
*
* @return exception
*/
MailboxException getException();
}