activemq-cpp-3.9.5
decaf::util::ArrayList< E > Class Template Reference

#include <src/main/decaf/util/ArrayList.h>

Inheritance diagram for decaf::util::ArrayList< E >:

Public Member Functions

 ArrayList ()
 
 ArrayList (const Collection< E > &collection)
 
 ArrayList (const ArrayList< E > &arrayList)
 
 ArrayList (int initialCapacity)
 
virtual ~ArrayList ()
 
ArrayList< E > & operator= (const ArrayList< E > &list)
 
ArrayList< E > & operator= (const Collection< E > &collection)
 
bool operator== (const ArrayList< E > &other) const
 
bool operator!= (const ArrayList< E > &other) const
 
void ensureCapacity (int minimumCapacity)
 Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
 
void trimToSize ()
 Trims the internal array to match the current size of the ArrayList.
 
virtual void clear ()
 Removes all of the elements from this collection (optional operation).
 
virtual bool isEmpty () const
 
virtual int size () const
 Returns the number of elements in this collection.
 
virtual E set (int index, const E &element)
 Replaces the element at the specified position in this list with the specified element.
 
virtual E get (int index) const
 Gets the element contained at position passed.
 
virtual bool add (const E &value)
 Returns true if this collection changed as a result of the call.
 
virtual void add (int index, const E &element)
 Inserts the specified element at the specified position in this list.
 
virtual bool addAll (const Collection< E > &collection)
 Adds all of the elements in the specified collection to this collection.
 
virtual bool addAll (int index, const Collection< E > &collection)
 Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
 
virtual bool remove (const E &value)
 Removes a single instance of the specified element from the collection.
 
virtual E removeAt (int index)
 Removes the element at the specified position in this list.
 
virtual bool contains (const E &value) const
 Returns true if this collection contains the specified element.
 
virtual int indexOf (const E &value) const
 Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
 
virtual int lastIndexOf (const E &value) const
 Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
 
virtual std::vector< E > toArray () const
 Returns an array containing all of the elements in this collection.
 
virtual std::string toString () const
 
- Public Member Functions inherited from decaf::util::AbstractList< E >
 AbstractList ()
 
virtual ~AbstractList ()
 
virtual Iterator< E > * iterator ()
 
virtual Iterator< E > * iterator () const
 
virtual ListIterator< E > * listIterator ()
 
virtual ListIterator< E > * listIterator () const
 
virtual ListIterator< E > * listIterator (int index)
 
virtual ListIterator< E > * listIterator (int index) const
 
virtual void add (int index DECAF_UNUSED, const E &element DECAF_UNUSED)
 
virtual E set (int index DECAF_UNUSED, const E &element DECAF_UNUSED)
 
- Public Member Functions inherited from decaf::util::List< E >
 List ()
 
virtual ~List ()
 
- Public Member Functions inherited from decaf::util::Collection< E >
virtual ~Collection ()
 
- Public Member Functions inherited from decaf::lang::Iterable< E >
virtual ~Iterable ()
 
- Public Member Functions inherited from decaf::util::concurrent::Synchronizable
virtual ~Synchronizable ()
 
- Public Member Functions inherited from decaf::util::AbstractCollection< E >
 AbstractCollection ()
 
 AbstractCollection (const AbstractCollection &other)
 Copy Constructor, copy element from the source collection to this collection after clearing any element stored in this collection.
 
virtual ~AbstractCollection ()
 
AbstractCollection< E > & operator= (const AbstractCollection< E > &collection)
 Assignment Operator, copy element from the source collection to this collection after clearing any element stored in this collection.
 
virtual bool containsAll (const Collection< E > &collection) const
 Returns true if this collection contains all of the elements in the specified collection.
Parameters
collectionThe Collection to compare to this one.
Exceptions
NullPointerExceptionif the Collection contains pointers and the Collection does not allow for NULL elements (optional check).

 
virtual bool equals (const Collection< E > &collection) const
 Answers true if this Collection and the one given are the same size and if each element contained in the Collection given is equal to an element contained in this collection.
 
virtual void copy (const Collection< E > &collection)
 Renders this Collection as a Copy of the given Collection.
 
virtual bool add (const E &value DECAF_UNUSED)
 
virtual bool removeAll (const Collection< E > &collection)
 Removes all this collection's elements that are also contained in the specified collection (optional operation).After this call returns, this collection will contain no elements in common with the specified collection.
Parameters
collectionThe Collection whose elements are to be removed from this one.
Returns
true if the collection changed as a result of this call.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

 
virtual bool retainAll (const Collection< E > &collection)
 Retains only the elements in this collection that are contained in the specified collection (optional operation).In other words, removes from this collection all of its elements that are not contained in the specified collection.
Parameters
collectionThe Collection whose elements are to be retained.
Returns
true if the collection changed as a result of this call.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

 
virtual void lock ()
 Locks the object.
 
virtual bool tryLock ()
 Attempts to Lock the object, if the lock is already held by another thread than this method returns false.
 
virtual void unlock ()
 Unlocks the object.
 
virtual void wait ()
 Waits on a signal from this object, which is generated by a call to Notify.
 
virtual void wait (long long millisecs)
 Waits on a signal from this object, which is generated by a call to Notify.
 
virtual void wait (long long millisecs, int nanos)
 Waits on a signal from this object, which is generated by a call to Notify.
 
virtual void notify ()
 Signals a waiter on this object that it can now wake up and continue.
 
virtual void notifyAll ()
 Signals the waiters on this object that it can now wake up and continue.
 

Additional Inherited Members

- Protected Member Functions inherited from decaf::util::AbstractList< E >
void removeRange (int start, int end)
 
- Protected Attributes inherited from decaf::util::AbstractList< E >
int modCount
 
- Protected Attributes inherited from decaf::util::AbstractCollection< E >
util::concurrent::Mutex mutex
 

Constructor & Destructor Documentation

◆ ArrayList() [1/4]

template<typename E>
decaf::util::ArrayList< E >::ArrayList ( )
inline

◆ ArrayList() [2/4]

◆ ArrayList() [3/4]

◆ ArrayList() [4/4]

template<typename E>
decaf::util::ArrayList< E >::ArrayList ( int initialCapacity)
inline

◆ ~ArrayList()

template<typename E>
virtual decaf::util::ArrayList< E >::~ArrayList ( )
inlinevirtual

Member Function Documentation

◆ add() [1/2]

template<typename E>
virtual bool decaf::util::ArrayList< E >::add ( const E & value)
inlinevirtual

Returns true if this collection changed as a result of the call.

(Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

For non-pointer values, i.e. class instances or string's the object will be copied into the collection, thus the object must support being copied, must not hide the copy constructor and assignment operator.

Parameters
valueThe reference to the element to add to this Collection.
Returns
true if the element was added to this Collection.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of the element prevents it from being added to this collection
IllegalStateExceptionif the element cannot be added at this time due to insertion restrictions.

Reimplemented from decaf::util::AbstractList< E >.

References decaf::util::AbstractList< E >::modCount.

◆ add() [2/2]

template<typename E>
virtual void decaf::util::ArrayList< E >::add ( int index,
const E & element )
inlinevirtual

Inserts the specified element at the specified position in this list.

Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters
indexThe index at which the specified element is to be inserted.
elementThe element to be inserted in this List.
Exceptions
IndexOutOfBoundsExceptionif the index is greater than size of the List.
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of the element prevents it from being added to this collection
IllegalStateExceptionif the element cannot be added at this time due to insertion restrictions.

Implements decaf::util::List< E >.

References decaf::util::AbstractList< E >::modCount.

◆ addAll() [1/2]

template<typename E>
virtual bool decaf::util::ArrayList< E >::addAll ( const Collection< E > & collection)
inlinevirtual

Adds all of the elements in the specified collection to this collection.

The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)

Parameters
collectionThe Collection whose elements are added to this one.
Returns
true if this collection changed as a result of the call
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of an element prevents it from being added to this collection
IllegalStateExceptionif an element cannot be added at this time due to insertion restrictions.

Implements decaf::util::Collection< E >.

References decaf::util::AbstractList< E >::modCount, decaf::util::Collection< E >::size(), and decaf::util::Collection< E >::toArray().

Referenced by operator=(), and operator=().

◆ addAll() [2/2]

template<typename E>
virtual bool decaf::util::ArrayList< E >::addAll ( int index,
const Collection< E > & source )
inlinevirtual

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).

Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Parameters
indexThe index at which to insert the first element from the specified collection
sourceThe Collection containing elements to be added to this list
Returns
true if this list changed as a result of the call
Exceptions
IndexOutOfBoundsExceptionif the index given is less than zero or greater than the List size.
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of the element prevents it from being added to this collection
IllegalStateExceptionif the element cannot be added at this time due to insertion restrictions.

Reimplemented from decaf::util::AbstractList< E >.

References decaf::util::AbstractList< E >::modCount, decaf::util::Collection< E >::size(), and decaf::util::Collection< E >::toArray().

◆ clear()

template<typename E>
virtual void decaf::util::ArrayList< E >::clear ( )
inlinevirtual

Removes all of the elements from this collection (optional operation).

This collection will be empty after this method returns unless it throws an exception.

Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.

Reimplemented from decaf::util::AbstractList< E >.

References ensureCapacity(), and decaf::util::AbstractList< E >::modCount.

Referenced by operator=(), and operator=().

◆ contains()

template<typename E>
virtual bool decaf::util::ArrayList< E >::contains ( const E & value) const
inlinevirtual

Returns true if this collection contains the specified element.

More formally, returns true if and only if this collection contains at least one element e such that (value == NULL ? e == NULL : value == e ).

Parameters
valueThe value to check for presence in the collection.
Returns
true if there is at least one of the elements in the collection
Exceptions
NullPointerExceptionif the Collection contains pointers and the Collection does not allow for NULL elements (optional check).

Implements decaf::util::Collection< E >.

References indexOf().

◆ ensureCapacity()

template<typename E>
void decaf::util::ArrayList< E >::ensureCapacity ( int minimumCapacity)
inline

Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

If the capacity is already greater than or equal to the minimum capacity argument then the array is left unchanged.

Parameters
minimumCapacityThe desired minimum capacity for this ArrayList.

References decaf::lang::System::arraycopy(), and decaf::util::AbstractList< E >::modCount.

Referenced by ArrayList(), and clear().

◆ get()

template<typename E>
virtual E decaf::util::ArrayList< E >::get ( int index) const
inlinevirtual

Gets the element contained at position passed.

Parameters
indexThe position to get.
Returns
value at index specified.
Exceptions
IndexOutOfBoundsExceptionif the index given is less than zero or greater than the List size.

Implements decaf::util::List< E >.

◆ indexOf()

template<typename E>
virtual int decaf::util::ArrayList< E >::indexOf ( const E & value) const
inlinevirtual

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

More formally, returns the lowest index i such that get(i) == value, or -1 if there is no such index.

Parameters
valueThe element to search for in this List.
Returns
the index of the first occurrence of the specified element in this list,
Exceptions
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

Reimplemented from decaf::util::AbstractList< E >.

Referenced by contains(), and remove().

◆ isEmpty()

template<typename E>
virtual bool decaf::util::ArrayList< E >::isEmpty ( ) const
inlinevirtual
Returns
true if this collection contains no elements.

Implements decaf::util::Collection< E >.

◆ lastIndexOf()

template<typename E>
virtual int decaf::util::ArrayList< E >::lastIndexOf ( const E & value) const
inlinevirtual

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

More formally, returns the highest index i such that get(i) == value or -1 if there is no such index.

Parameters
valueThe element to search for in this List.
Returns
the index of the last occurrence of the specified element in this list.
Exceptions
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

Reimplemented from decaf::util::AbstractList< E >.

◆ operator!=()

template<typename E>
bool decaf::util::ArrayList< E >::operator!= ( const ArrayList< E > & other) const
inline

◆ operator=() [1/2]

template<typename E>
ArrayList< E > & decaf::util::ArrayList< E >::operator= ( const ArrayList< E > & list)
inline

References addAll(), ArrayList(), and clear().

◆ operator=() [2/2]

template<typename E>
ArrayList< E > & decaf::util::ArrayList< E >::operator= ( const Collection< E > & collection)
inline

References addAll(), ArrayList(), and clear().

◆ operator==()

template<typename E>
bool decaf::util::ArrayList< E >::operator== ( const ArrayList< E > & other) const
inline

◆ remove()

template<typename E>
virtual bool decaf::util::ArrayList< E >::remove ( const E & value)
inlinevirtual

Removes a single instance of the specified element from the collection.

More formally, removes an element e such that (value == NULL ? e == NULL : value == e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Parameters
valueThe reference to the element to remove from this Collection.
Returns
true if the collection was changed, false otherwise.
Exceptions
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.

Implements decaf::util::Collection< E >.

References indexOf(), and removeAt().

◆ removeAt()

template<typename E>
virtual E decaf::util::ArrayList< E >::removeAt ( int index)
inlinevirtual

Removes the element at the specified position in this list.

Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters
index- the index of the element to be removed.
Returns
the element previously at the specified position.
Exceptions
IndexOutOfBoundsExceptionif the index given is less than zero or greater than the List size.
UnsupportedOperationExceptioif this is an unmodifiable collection.

Reimplemented from decaf::util::AbstractList< E >.

References decaf::util::System::arraycopy(), and decaf::util::AbstractList< E >::modCount.

Referenced by remove().

◆ set()

template<typename E>
virtual E decaf::util::ArrayList< E >::set ( int index,
const E & element )
inlinevirtual

Replaces the element at the specified position in this list with the specified element.

Parameters
indexThe index of the element to replace.
elementThe element to be stored at the specified position.
Returns
the element previously at the specified position.
Exceptions
IndexOutOfBoundsExceptionif the index given is less than zero or greater than the List size.
UnsupportedOperationExceptioif this is an unmodifiable collection.
NullPointerExceptionif the Collection is a container of pointers and does not allow NULL values.
IllegalArgumentExceptionif some property of the element prevents it from being added to this collection
IllegalStateExceptionif the element cannot be added at this time due to insertion restrictions.

Implements decaf::util::List< E >.

◆ size()

template<typename E>
virtual int decaf::util::ArrayList< E >::size ( ) const
inlinevirtual

Returns the number of elements in this collection.

If this collection contains more than Integer::MAX_VALUE elements, returns Integer::MAX_VALUE.

Returns
the number of elements in this collection

Implements decaf::util::Collection< E >.

Referenced by ArrayList().

◆ toArray()

template<typename E>
virtual std::vector< E > decaf::util::ArrayList< E >::toArray ( ) const
inlinevirtual

Returns an array containing all of the elements in this collection.

If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

This method acts as bridge between array-based and collection-based APIs.

Returns
an array of the elements in this collection in the form of an STL vector.

Implements decaf::util::Collection< E >.

◆ toString()

template<typename E>
virtual std::string decaf::util::ArrayList< E >::toString ( ) const
inlinevirtual

◆ trimToSize()

template<typename E>
void decaf::util::ArrayList< E >::trimToSize ( )
inline

Trims the internal array to match the current size of the ArrayList.

This compacts the internal array to save storage space used by this ArrayList.

References decaf::util::System::arraycopy(), and decaf::util::AbstractList< E >::modCount.


The documentation for this class was generated from the following file: