1   /**
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   package org.apache.activemq.memory.list;
   18   
   19   import java.util.List;
   20   import org.apache.activemq.broker.region.MessageReference;
   21   import org.apache.activemq.command.ActiveMQDestination;
   22   import org.apache.activemq.command.Message;
   23   
   24   /**
   25    * A container of messages which is used to store messages and then 
   26    * replay them later for a given subscription.
   27    * 
   28    * @version $Revision: 1.1 $
   29    */
   30   public interface MessageList {
   31   
   32       void add(MessageReference node);
   33   
   34       /**
   35        * Returns the current list of MessageReference objects for the given subscription
   36        */
   37       List getMessages(ActiveMQDestination destination);
   38       
   39       /**
   40        * @param destination
   41        * @return an array of Messages that match the destination
   42        */
   43       Message[] browse(ActiveMQDestination destination);
   44   
   45       void clear();
   46       
   47       
   48   }