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