Jive reference manual
List of all members | Public Member Functions | Protected Member Functions | Friends
jem::util::ObjectList Class Reference

#include <jem/util/ObjectList.h>

Inheritance diagram for jem::util::ObjectList:
Inheritance graph

Public Member Functions

 ObjectList ()
 
virtual void readFrom (io::ObjectInput &in)
 
virtual void writeTo (io::ObjectOutput &out) const
 
virtual Ref< Objectclone () const
 
virtual Ref< SeqEnumgetSeqEnum () const
 
virtual void insert (idx_t idx, const Ref< Object > &obj)
 
virtual void insertSpace (idx_t idx, idx_t count)
 
virtual void erase (idx_t idx)
 
virtual void eraseRange (idx_t from, idx_t to)
 
virtual Ref< Objectget (idx_t idx) const
 
virtual void set (idx_t idx, const Ref< Object > &obj)
 
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...
 
virtual void reserve (idx_t count)
 
virtual void trimToSize ()
 Deallocates non-used memory. More...
 
virtual idx_t capacity () const
 Returns the capacity of this collection. More...
 
virtual idx_t size () const
 Returns the number of objects in this collection. More...
 
- Public Member Functions inherited from jem::util::ObjectSequence
Ref< SeqEnumenumerate () const
 
virtual Ref< EnumeratorgetEnumerator () const
 Returns an enumerator over 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...
 
- 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 ~ObjectList ()
 
- Protected Member Functions inherited from jem::util::ObjectSequence
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...
 
- Protected Member Functions inherited from jem::Clonable
virtual ~Clonable ()
 
virtual void emitVTable_ ()
 
- Protected Member Functions inherited from jem::io::Serializable
virtual ~Serializable ()
 
virtual void emitVtableFunc_ ()
 

Friends

class Enumerator_
 

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

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

Member Function Documentation

virtual void jem::util::ObjectList::readFrom ( io::ObjectInput in)
virtual

Implements jem::io::Serializable.

virtual void jem::util::ObjectList::writeTo ( io::ObjectOutput out) const
virtual

Implements jem::io::Serializable.

virtual Ref<Object> jem::util::ObjectList::clone ( ) const
virtual

Implements jem::Clonable.

virtual Ref<SeqEnum> jem::util::ObjectList::getSeqEnum ( ) const
virtual
virtual void jem::util::ObjectList::insert ( idx_t  idx,
const Ref< Object > &  obj 
)
virtual
virtual void jem::util::ObjectList::insertSpace ( idx_t  idx,
idx_t  count 
)
virtual

Reimplemented from jem::util::ObjectSequence.

virtual void jem::util::ObjectList::erase ( idx_t  idx)
virtual
virtual void jem::util::ObjectList::eraseRange ( idx_t  from,
idx_t  to 
)
virtual

Reimplemented from jem::util::ObjectSequence.

virtual Ref<Object> jem::util::ObjectList::get ( idx_t  idx) const
virtual
virtual void jem::util::ObjectList::set ( idx_t  idx,
const Ref< Object > &  obj 
)
virtual
virtual bool jem::util::ObjectList::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.

Reimplemented from jem::util::ObjectSequence.

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

Reimplemented from jem::util::ObjectSequence.

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

Reimplemented from jem::util::ObjectSequence.

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

Reimplemented from jem::util::ObjectSequence.

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

Reimplemented from jem::util::ObjectSequence.

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

Reimplemented from jem::util::ObjectSequence.

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

Reimplemented from jem::util::ObjectSequence.

virtual void jem::util::ObjectList::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

Reimplemented from jem::util::ObjectSequence.

virtual void jem::util::ObjectList::reserve ( idx_t  count)
virtual
virtual void jem::util::ObjectList::trimToSize ( )
virtual

Notifies this collection that it should deallocate non-used memory. Call this function after you have added all objects to this collection.

For efficiency reasons, an ObjectCollection may allocate extra memory each time that an object is added and no more free space is left in its internal data structures. This means that the ObjectCollection may use more memory than is actually needed to store all objects. This member function informs the ObjectCollection that no more new objects will be added and that it should shrink its data structures as much as possible.

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

See also
reserve(), capacity()

Reimplemented from jem::util::ObjectCollection.

virtual idx_t jem::util::ObjectList::capacity ( ) const
virtual

Returns the number of objects that this collection can contain without having to expand its internal data structures. This number is called the capacity of this collection.

The implementation of this function provided by the ObjectCollection class simply returns size().

Returns
The capacity of this collection.

Reimplemented from jem::util::ObjectCollection.

virtual idx_t jem::util::ObjectList::size ( ) const
virtual

Returns the number of objects in this collection.

Returns
The number of objects in this collection.

Implements jem::util::ObjectCollection.

Friends And Related Function Documentation

friend class Enumerator_
friend