org.mule.api.MuleMessageCollection Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mule-core

Mule server and core classes

There is a newer version: 3.9.0

/*
 * $Id: MuleMessageCollection.java 20321 2010-11-24 15:21:24Z dfeist $
 * --------------------------------------------------------------------------------------
 * 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.api;

import java.util.List;

/**
 * An interface that defines a collection of Mule Messages and methods for working with the collection.
 * Typically this type of message is only used when users explicitly want to work with aggregated or re-sequenced
 * collections of messages.
 */
public interface MuleMessageCollection extends MuleMessage
{
    void addMessage(MuleMessage message);

    void addMessage(MuleMessage message, int index);

    void addMessages(MuleMessage[] messages);

    void addMessages(MuleEvent[] events);

    void addMessages(List messages);

    void removedMessage(MuleMessage message);

    MuleMessage[] getMessagesAsArray();

    MuleMessage getMessage(int index);

    Object[] getPayloadsAsArray();

    int size();
}