Class ObjectDoubleWormMap.KeysContainer

    • Constructor Summary

      Constructors 
      Constructor Description
      KeysContainer()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Removes all elements from this collection.
      boolean contains​(KType e)
      Lookup a given element in the container.
      protected boolean equals​(java.lang.Object v1, java.lang.Object v2)  
      <T extends ObjectProcedure<? super KType>>
      T
      forEach​(T procedure)
      Applies a procedure to all container elements.
      boolean isEmpty()
      Shortcut for size() == 0.
      java.util.Iterator<ObjectCursor<KType>> iterator()
      Returns an iterator to a cursor traversing the collection.
      void release()
      Removes all elements from the collection and additionally releases any internal buffers.
      int removeAll​(ObjectLookupContainer<? super KType> c)
      Default implementation uses a predicate for removal.
      int removeAll​(ObjectPredicate<? super KType> predicate)
      Removes all elements in this collection for which the given predicate returns true.
      int removeAll​(KType e)
      Removes all occurrences of e from this collection.
      int retainAll​(ObjectLookupContainer<? super KType> c)
      Default implementation uses a predicate for retaining.
      int retainAll​(ObjectPredicate<? super KType> predicate)
      Default implementation redirects to ObjectCollection.removeAll(ObjectPredicate) and negates the predicate.
      int size()
      Return the current number of elements in this container.
      java.lang.Object[] toArray()
      Default implementation of copying to an array.
      <T> T[] toArray​(java.lang.Class<T> componentClass)
      Copies all elements of this container to a dynamically created array of the given component type.
      java.lang.String toString()
      Convert the contents of this container to a human-friendly string.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Constructor Detail

      • KeysContainer

        public KeysContainer()
    • Method Detail

      • contains

        public boolean contains​(KType e)
        Description copied from interface: ObjectContainer
        Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).
        Specified by:
        contains in interface ObjectContainer<KType>
        Specified by:
        contains in interface ObjectLookupContainer<KType>
        Returns:
        Returns true if this container has an element equal to e.
      • forEach

        public <T extends ObjectProcedure<? super KType>> T forEach​(T procedure)
        Description copied from interface: ObjectContainer
        Applies a procedure to all container elements. Returns the argument (any subclass of ObjectProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):
         int count = container.forEach(new IntProcedure() {
           int count; // this is a field declaration in an anonymous class.
         
           public void apply(int value) {
             count++;
           }
         }).count;
         
        Specified by:
        forEach in interface ObjectContainer<KType>
      • forEach

        public <T extends ObjectPredicate<? super KType>> T forEach​(T predicate)
        Description copied from interface: ObjectContainer
        Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
        Specified by:
        forEach in interface ObjectContainer<KType>
      • iterator

        public java.util.Iterator<ObjectCursor<KType>> iterator()
        Description copied from interface: ObjectContainer
        Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.

        The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below.

         for (ObjectCursor<Object> c : container) {
           System.out.println("index=" + c.index + " value=" + c.value);
         }
         
        Specified by:
        iterator in interface java.lang.Iterable<ObjectCursor<KType>>
        Specified by:
        iterator in interface ObjectContainer<KType>
      • size

        public int size()
        Description copied from interface: ObjectContainer
        Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
        Specified by:
        size in interface ObjectContainer<KType>
      • removeAll

        public int removeAll​(KType e)
        Description copied from interface: ObjectCollection
        Removes all occurrences of e from this collection.
        Specified by:
        removeAll in interface ObjectCollection<KType>
        Parameters:
        e - Element to be removed from this collection, if present.
        Returns:
        The number of removed elements as a result of this call.
      • removeAll

        public int removeAll​(ObjectLookupContainer<? super KType> c)
        Default implementation uses a predicate for removal.
        Specified by:
        removeAll in interface ObjectCollection<KType>
        Returns:
        Returns the number of removed elements.
      • retainAll

        public int retainAll​(ObjectLookupContainer<? super KType> c)
        Default implementation uses a predicate for retaining.
        Specified by:
        retainAll in interface ObjectCollection<KType>
        Returns:
        Returns the number of removed elements.
      • toArray

        public java.lang.Object[] toArray()
        Default implementation of copying to an array.
        Specified by:
        toArray in interface ObjectContainer<KType>
      • toArray

        public <T> T[] toArray​(java.lang.Class<T> componentClass)
        Description copied from interface: ObjectContainer
        Copies all elements of this container to a dynamically created array of the given component type.
        Specified by:
        toArray in interface ObjectContainer<KType>
      • toString

        public java.lang.String toString()
        Convert the contents of this container to a human-friendly string.
        Overrides:
        toString in class java.lang.Object
      • equals

        protected boolean equals​(java.lang.Object v1,
                                 java.lang.Object v2)