SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform::Lang::TypeConcepts
Template Class GeneralCollectionType

GeneralContainerType
   |
   +-GeneralCollectionType

Implemented in:
Platform.Lang.TypeConcepts.GeneralCollectionType.h
Direct Known Subclasses:
GeneralSequenceType, GeneralSetType

template <typename Base, typename Container, typename ElementType>
class GeneralCollectionType:
public GeneralContainerType

The base type for all the collection-based, non-associative containers.

A collection-based container consists of elements. There are no restrictions on the order in which the elements exist in a collection, nor whether the collection permits duplicate elements or not.

Fields inherited from class GeneralContainerTypecollapse
base

Method Summarycollapse
Bool contains(const ElementType& object) const
          Tests whether this container contains the specified element.
Bool containsAll(const Container& container) const
          Tests whether this container contains all of the elements of the specified container.
template <typename ContainerX>
Bool
containsAll(const ContainerX& container) const
          Tests whether this container contains all of the elements of the specified container.
Bool remove(const ElementType& object)
          Removes the first occurrence of the specified element from this container.
Int removeAll(const Container& container)
          Removes from this container all of its elements that exist in the specified container.
template <typename ContainerX>
Int
removeAll(const ContainerX& container)
          Removes from this container all of its elements that exist in the specified container.
Int retainAll(const Container& container)
          Retains only the elements in this container that exist in the specified container.
template <typename ContainerX>
Int
retainAll(const ContainerX& container)
          Retains only the elements in this container that exist in the specified container.

Methods inherited from class GeneralContainerTypecollapse
compareTo, deepSize, empty, equals, exchangeWith, hashCode, isEmpty, size, toString, toXml

 

Method Detail

contains[inline]

Bool contains(const ElementType& object) const

Tests whether this container contains the specified element.

Parameters:
object - the element to find
Returns:
True if this container contains the specified element, False otherwise

containsAll[inline]

Bool containsAll(const Container& container) const

Tests whether this container contains all of the elements of the specified container. If the specified container is empty this method returns True.

Parameters:
container - the container holding the elements to find
Returns:
True if this container contains all of the elements from the specified container, False otherwise

containsAll[inline]

template <typename ContainerX>
Bool containsAll(const ContainerX& container) const

Tests whether this container contains all of the elements of the specified container. If the specified container is empty this method returns True.

Parameters:
container - the container holding the elements to find
Returns:
True if this container contains all of the elements from the specified container, False otherwise

remove[inline]

Bool remove(const ElementType& object)

Removes the first occurrence of the specified element from this container. If the specified element is not found the container remains unmodified.

Parameters:
object - the element to remove
Returns:
True if the specified element was found and removed, False otherwise

removeAll[inline]

Int removeAll(const Container& container)

Removes from this container all of its elements that exist in the specified container.

Parameters:
container - the container containing elements to remove
Returns:
the number of elements removed from this container

removeAll[inline]

template <typename ContainerX>
Int removeAll(const ContainerX& container)

Removes from this container all of its elements that exist in the specified container.

Parameters:
container - the container containing elements to remove
Returns:
the number of elements removed from this container

retainAll[inline]

Int retainAll(const Container& container)

Retains only the elements in this container that exist in the specified container.

Parameters:
container - the container containing elements to retain
Returns:
the number of elements removed from this container

retainAll[inline]

template <typename ContainerX>
Int retainAll(const ContainerX& container)

Retains only the elements in this container that exist in the specified container.

Parameters:
container - the container containing elements to retain
Returns:
the number of elements removed from this container


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND