org.mule.routing.MessageSequence Maven / Gradle / Ivy
/*
* $Id: MessageSequence.java 22272 2011-06-27 16:17:16Z mike.schilling $
* --------------------------------------------------------------------------------------
* Copyright (c) MuleSoft, Inc. All rights reserved. http://www.mulesoft.com
*
* The software in this package is published under the terms of the CPAL v1.0
* license, a copy of which has been included with this distribution in the
* LICENSE.txt file.
*/
package org.mule.routing;
import java.util.Iterator;
/**
* A sequence of messages
*
* @author flbulgarelli
* @param the message payload type
*/
public interface MessageSequence extends Iterator
{
int UNKNOWN_SIZE = -1;
/**
* If the sequence is empty
*
* @return !hasNext()
*/
boolean isEmpty();
/**
* The number of members of the sequence. If this is unknown, return UNKNOWN_ELEMENTS_COUNT.
*
* @return The estimated size of the sequence, or {@link #UNKNOWN_SIZE},
* if it is unknown
*/
int size();
/**
* Whether this sequence has more elements.
*
* @see Iterator#hasNext()
*/
@Override
public boolean hasNext();
/**
* The next element of the sequence. At any moment, if
* {@link #size()} is not equal to
* {@link #UNKNOWN_SIZE}, this means that this method may be invoked
* approximately up to {@link #size()} times.
*/
@Override
public T next();
/**
* Unsupported operation.
* {@link MessageSequence} do not allow removal of elements.
*/
@Override
public void remove();
}