Collection.h

Go to the documentation of this file.

/*
 * Collection.h
 *
 * Smalltalk like class library for C++
 * Abstract collection with common functionality. 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 __COLLECTION_H
#define __COLLECTION_H

#include <stlib/Object.h>
#include <stlib/CollectionIterator.h>

namespace Core {

class Array;
class OrderedCollection;
class Set;
class Stream;
class String;
class Visitor;

class Collection : public Object
{
  public:
    /* Class-accessing protocol */
    virtual String *className(void) const;

    /* Accessing protocol */
    virtual long capacity(void) const;
    virtual long size(void) const abstract;
    virtual Object *any(void) abstract;

    /* Adding protocol */
    virtual void add(Object *) abstract;
    virtual void addAll(Collection *);

    /* Converting protocol */
    virtual Array *asArray(void);
    virtual OrderedCollection *asOrderedCollection(void);
    virtual Set *asSet(void);

    /* Copying protocol */
    virtual Object *copy(void) abstract;
    virtual Object *copyEmpty(long size) abstract;

    /* Enumeration protocol */
    virtual Iterator *iterator(void) const;

    /* Printing protocol */
    virtual void printOn(Stream *stream) const;
    virtual String *printSeparatedBy(String *separator) const;
    virtual String *printSeparatedBy(const char *separator) const;
    virtual void printSeparatedOn(Stream *stream, String *separator) const;
    virtual void printSeparatedOn(Stream *stream, const char *separator) const;

    /* Removing protocol */
    virtual Object *remove(Object *) abstract;
    virtual void removeAll(Collection *items);

    /* Testing protocol */
    virtual bool includes(Object *);
    virtual bool isByteArray(void);
    virtual bool isEmpty(void);
    virtual bool isSequenceable(void) const;

    /* Visiting protocol */
    virtual void visitBy(Visitor *visitor);

  protected:
    /* Enumeration protocol */
    friend void CollectionIterator::next(void);
    virtual Object *privNextForIterator(CollectionIterator *iter) const abstract;

    /* Private protocol */
    virtual void emptyCheck(void);
    virtual long growSize(void);
};

};

#endif /* __COLLECTION_H */

---