View Javadoc

1   /*
2    * $Id: MuleMessageCollection.java 20321 2010-11-24 15:21:24Z dfeist $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  package org.mule.api;
11  
12  import java.util.List;
13  
14  /**
15   * An interface that defines a collection of Mule Messages and methods for working with the collection.
16   * Typically this type of message is only used when users explicitly want to work with aggregated or re-sequenced
17   * collections of messages.
18   */
19  public interface MuleMessageCollection extends MuleMessage
20  {
21      void addMessage(MuleMessage message);
22  
23      void addMessage(MuleMessage message, int index);
24  
25      void addMessages(MuleMessage[] messages);
26  
27      void addMessages(MuleEvent[] events);
28  
29      void addMessages(List messages);
30  
31      void removedMessage(MuleMessage message);
32  
33      MuleMessage[] getMessagesAsArray();
34  
35      MuleMessage getMessage(int index);
36  
37      Object[] getPayloadsAsArray();
38  
39      int size();
40  }