Jive reference manual
List of all members | Public Member Functions | Protected Member Functions
jem::util::ObjectSequence Class Referenceabstract

#include <jem/util/ObjectSequence.h>

Inheritance diagram for jem::util::ObjectSequence:
Inheritance graph

Public Member Functions

Ref< SeqEnumenumerate () const
 
virtual Ref< EnumeratorgetEnumerator () const
 Returns an enumerator over this collection. More...
 
virtual Ref< SeqEnumgetSeqEnum () const =0
 
virtual void insert (idx_t idx, const Ref< Object > &obj)=0
 
virtual void insertSpace (idx_t idx, idx_t count)
 
virtual void erase (idx_t idx)=0
 
virtual void eraseRange (idx_t first, idx_t last)
 
virtual Ref< Objectget (idx_t idx) const =0
 
virtual void set (idx_t idx, const Ref< Object > &obj)=0
 
virtual bool add (const Ref< Object > &obj)
 Adds an object to this collection. More...
 
virtual Ref< Objectfront () const
 
virtual Ref< Objectback () const
 
virtual void pushBack (const Ref< Object > &obj)
 
virtual void pushFront (const Ref< Object > &obj)
 
virtual void popBack ()
 
virtual void popFront ()
 
virtual void clear ()
 Deletes all objects from this collection. More...
 
- Public Member Functions inherited from jem::util::ObjectCollection
virtual ClassgetClass () const
 Returns the Class instance representing the runtime class of this object. More...
 
Ref< Enumeratorenumerate () const
 Returns an enumerator over this collection. More...
 
virtual void reserve (int n)
 Pre-allocates data structures for storing additional objects. More...
 
virtual void trimToSize ()
 Deallocates non-used memory. More...
 
virtual int capacity () const
 Returns the capacity of this collection. More...
 
virtual int size () const =0
 Returns the number of objects in this collection. More...
 
- Public Member Functions inherited from jem::Object
virtual String toString () const
 Returns a short textual description of this object. More...
 
virtual long hashValue () const
 Returns a hash value for this object. More...
 
virtual bool equals (const Ref< Object > &obj) const
 Tests whether two objects are equal. More...
 
Ref< Objectclone () const
 Returns a copy of this object. More...
 

Protected Member Functions

virtual ~ObjectSequence ()
 
void emptyError_ () const
 
void indexError_ (idx_t idx) const
 
void indexError_ (idx_t idx, idx_t ubound) const
 
- Protected Member Functions inherited from jem::util::ObjectCollection
virtual ~ObjectCollection ()
 
void clone_ (const ObjectCollection &rhs)
 Makes a deep copy of another collection. More...
 
void readFrom_ (io::ObjectInput &in)
 Reads the contents of this collection from an object input stream. More...
 
void writeTo_ (io::ObjectOutput &out) const
 Writes the contents of this collection to an object output stream. More...
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 
- Protected Member Functions inherited from jem::util::Enumerable
virtual ~Enumerable ()
 
- Protected Member Functions inherited from jem::Interface
virtual ~Interface ()
 Empty destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from jem::util::ObjectCollection
static ClassmakeClass ()
 
static ClassgetType ()
 
- Static Public Member Functions inherited from jem::Object
static ClassgetType ()
 Returns the Class instance representing the Object class. More...
 

Constructor & Destructor Documentation

virtual jem::util::ObjectSequence::~ObjectSequence ( )
protectedvirtual

Member Function Documentation

Ref<SeqEnum> jem::util::ObjectSequence::enumerate ( ) const
virtual Ref<Enumerator> jem::util::ObjectSequence::getEnumerator ( ) const
virtual

Returns an Enumerator that can be used to iterate over all objects in this collection. This object collection may not be structurally modified as long as one or more enumerators are pointing to it.

Implements jem::util::ObjectCollection.

virtual Ref<SeqEnum> jem::util::ObjectSequence::getSeqEnum ( ) const
pure virtual

Implemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::insert ( idx_t  idx,
const Ref< Object > &  obj 
)
pure virtual

Implemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::insertSpace ( idx_t  idx,
idx_t  count 
)
virtual

Reimplemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::erase ( idx_t  idx)
pure virtual

Implemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::eraseRange ( idx_t  first,
idx_t  last 
)
virtual

Reimplemented in jem::util::ObjectList.

virtual Ref<Object> jem::util::ObjectSequence::get ( idx_t  idx) const
pure virtual

Implemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::set ( idx_t  idx,
const Ref< Object > &  obj 
)
pure virtual

Implemented in jem::util::ObjectList.

virtual bool jem::util::ObjectSequence::add ( const Ref< Object > &  obj)
virtual

Requests that the object obj is added to this collection. This function returns true if the object has been added, and false otherwise. An implementation of this function does not have to add the object if it is already present in this collection and if all objects in this collection should be unique.

This function may not be called if an enumerator points to this collection.

Parameters
obj- the object to be added.
Returns
true if the object has been added to this collection, and false otherwise.

Implements jem::util::ObjectCollection.

Reimplemented in jem::util::ObjectList.

virtual Ref<Object> jem::util::ObjectSequence::front ( ) const
virtual

Reimplemented in jem::util::ObjectList.

virtual Ref<Object> jem::util::ObjectSequence::back ( ) const
virtual

Reimplemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::pushBack ( const Ref< Object > &  obj)
virtual

Reimplemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::pushFront ( const Ref< Object > &  obj)
virtual

Reimplemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::popBack ( )
virtual

Reimplemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::popFront ( )
virtual

Reimplemented in jem::util::ObjectList.

virtual void jem::util::ObjectSequence::clear ( )
virtual

Deletes all objects from this collection.

This function may not be called if an enumerator points to this collection.

Postcondition
this->size() == 0

Implements jem::util::ObjectCollection.

Reimplemented in jem::util::ObjectList.

void jem::util::ObjectSequence::emptyError_ ( ) const
protected
void jem::util::ObjectSequence::indexError_ ( idx_t  idx) const
protected
void jem::util::ObjectSequence::indexError_ ( idx_t  idx,
idx_t  ubound 
) const
protected