uk.org.retep.xmpp.muc.MucRoomHistory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of multiUserChat Show documentation
The newest version!
/*
 * Copyright (c) 1998-2010, Peter T Mount

 * All rights reserved.
 *
 * 
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 * 
 *
 * 
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 * 
 *
 * 
 *   You should have received a copy of the GNU General Public License along
 *   with this program.  If not, see .
 * 
 *
 * 
 *        GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
 * 
 *
 * 
 *   Linking this library statically or dynamically with other modules
 *   is making a combined work based on this library. Thus, the terms
 *   and conditions of the GNU General Public License cover the whole
 *   combination.
 * 
 *
 * 
 *   As a special exception, the copyright holders of this library give
 *   you permission to link this library with independent modules to
 *   produce an executable, regardless of the license terms of these
 *   independent modules, and to copy and distribute the resulting
 *   executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the
 *   license of that module.
 * 
 *
 * 
 *   An independent module is a module which is either not derived from or based
 *   on this library, or a module who's classes extend those within this library
 *   as part of the implementation of the library.
 * 
 *
 * 
 *   If you modify this library, you may extend this exception to your version
 *   of the library, but you are not obligated to do so. If you do not wish to
 *   do so, delete this exception statement from your version.
 * 
 */
package uk.org.retep.xmpp.muc;

import java.util.Collection;
import org.jabber.protocol.muc.History;
import uk.org.retep.xmpp.message.Stanza;

/**
 * An implementation of some form of storage of messages so that discussion
 * history (XEP0045 7.1.15) can be implemented.
 *
 * @author peter
 */
public interface MucRoomHistory
{

    /**
     * Add a message to the collection
     * @param 
     * @param message
     */
     void add( T message );

    /**
     * The number of entries in the collection
     *
     * @return
     */
    int size();

    /**
     * Return all entries in the collection.
     *
     * 
     *   The returned Collection will be ordered in chronological order with
     *   the oldest entry first.
     * 
     *
     * 
     *   This is identical to get( null )
     * 
     *
     * @return Collection of messages in chronological order
     */
    Collection get();

    /**
     * Return the available entries in the collection that match the criteria
     * specified in spec.
     *
     * 
     *   The returned Collection will be ordered in chronological order with
     *   the oldest entry first.
     * 
     *
     * @param spec History specification defined under XEP0045 7.1.16
     * @return Collection of messages in chronological order
     */
    Collection get( History spec );

    /**
     * Removes all entries from this instance.
     */
    void clear();

    /**
     * Copies all history from another instance.
     *
     * @param history MucRoomHistory to copy from.
     */
    void addAll( MucRoomHistory history );
}