SequenceableCollection.h

Go to the documentation of this file.

/*
 * SequenceableCollection.h
 *
 * Smalltalk like class library for C++
 * Abstract index-accessible collection. Header.
 *
 * Copyright (c) 2003 Milan Cermak
 */
/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __SEQUENCEABLECOLLECTION_H
#define __SEQUENCEABLECOLLECTION_H

#include <stlib/Collection.h>

namespace Core {

class Array;
class ByteArray;
class CollectionIterator;
class String;
class ReadStream;
class ReadAppendStream;
class WriteStream;

class SequenceableCollection : public Collection
{
  public:
    /* Accessing protocol */
    virtual Object *any(void);
    virtual Object *at(int index) const abstract;
    virtual void put(int index, Object *obj) abstract;
    virtual long size(void) const abstract;
    virtual Object *first(void);
    virtual Object *last(void);
    virtual void replace(long start, long stop,
                         const SequenceableCollection *collection);
    virtual void replace(long start, long stop,
                         const SequenceableCollection *collection, long startIndex);
    virtual void replaceAll(Object *element, Object *replacement);
    virtual void replaceAll(Object *element, Object *replacement,
                            long startIndex, long stopIndex);

    virtual long indexOf(Object *element) const;
    virtual long lastIndexOf(Object *element) const;
    virtual long nextIndexOf(Object *element, long startIndex, long stopIndex) const;
    virtual long prevIndexOf(Object *element, long startIndex, long stopIndex) const;

    virtual long indexOfSubCollection(SequenceableCollection *coll) const;
    virtual long indexOfSubCollection(SequenceableCollection *coll,
                                      long startIndex) const;

    /* Adding protocol */
    virtual void changeSize(long newSize) abstract;
    virtual void grow(void);
    virtual void growToAtLeast(long items);

    /* Converting protocol */
    virtual Array *asArray(void);
    virtual ByteArray *asByteArray(void);
    virtual String *asString(void);
    virtual ReadStream *readStream(void);
    virtual ReadAppendStream *readAppendStream(void);
    virtual WriteStream *writeStream(void);

    /* Copying protocol */
    virtual Object *copy(void) abstract;
    virtual Object *copy(long from, long to);
    virtual SequenceableCollection *copyReplace(long from, long to,
                                                SequenceableCollection *replacement);
    virtual SequenceableCollection &operator+(SequenceableCollection &collection);

    /* Removing protocol */
    virtual Object *remove(Object *);

    /* Testing protocol */
    virtual bool includesSubcollection(SequenceableCollection *coll) const;
    virtual bool isSequenceable(void) const;
    virtual bool startsWith(SequenceableCollection *coll) const;
    virtual bool endsWith(SequenceableCollection *coll) const;

  protected:
    /* Enumeration protocol */
    virtual Object *privNextForIterator(CollectionIterator *iter) const;
};

};

#endif /* __SEQUENCEABLECOLLECTION_H */

---