Package com.carrotsearch.hppc

Class CharCharWormMap.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​(char e)
      Lookup a given element in the container.
      <T extends CharProcedure>
      T      		 forEach​(T procedure)
      Applies a procedure to all container elements.
      boolean isEmpty()
      Shortcut for size() == 0.
      java.util.Iterator<CharCursor> 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​(char e)
      Removes all occurrences of e from this collection.
      int removeAll​(CharLookupContainer c)
      Default implementation uses a predicate for removal.
      int removeAll​(CharPredicate predicate)
      Removes all elements in this collection for which the given predicate returns true.
      int retainAll​(CharLookupContainer c)
      Default implementation uses a predicate for retaining.
      int retainAll​(CharPredicate predicate)
      Default implementation redirects to CharCollection.removeAll(CharPredicate) and negates the predicate.
      int size()
      Return the current number of elements in this container.
      char[] toArray()
      Default implementation of copying to an array.
      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​(char e)
        Description copied from interface: CharContainer
        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 CharContainer
        Specified by:
        contains in interface CharLookupContainer
        Returns:
        Returns true if this container has an element equal to e.

      • forEach

        public <T extends CharProcedure> T forEach​(T procedure)
        Description copied from interface: CharContainer
        Applies a procedure to all container elements. Returns the argument (any subclass of CharProcedure. 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 CharContainer

      • forEach

        public <T extends CharPredicate> T forEach​(T predicate)
        Description copied from interface: CharContainer
        Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.
        Specified by:
        forEach in interface CharContainer

      • iterator

        public java.util.Iterator<CharCursor> iterator()
        Description copied from interface: CharContainer
        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 (CharCursor<char> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
        Specified by:
        iterator in interface CharContainer
        Specified by:
        iterator in interface java.lang.Iterable<CharCursor>

      • size

        public int size()
        Description copied from interface: CharContainer
        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 CharContainer

      • release

        public void release()
        Description copied from interface: CharCollection
        Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple CharCollection.clear() should be a better alternative since it'll avoid reallocation.
        Specified by:
        release in interface CharCollection
        See Also:
        CharCollection.clear()

      • removeAll

        public int removeAll​(CharPredicate predicate)
        Description copied from interface: CharCollection
        Removes all elements in this collection for which the given predicate returns true.
        Specified by:
        removeAll in interface CharCollection
        Returns:
        Returns the number of removed elements.

      • removeAll

        public int removeAll​(char e)
        Description copied from interface: CharCollection
        Removes all occurrences of e from this collection.
        Specified by:
        removeAll in interface CharCollection
        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​(CharLookupContainer c)
        Default implementation uses a predicate for removal.
        Specified by:
        removeAll in interface CharCollection
        Returns:
        Returns the number of removed elements.

      • retainAll

        public int retainAll​(CharLookupContainer c)
        Default implementation uses a predicate for retaining.
        Specified by:
        retainAll in interface CharCollection
        Returns:
        Returns the number of removed elements.

      • toArray

        public char[] toArray()
        Default implementation of copying to an array.
        Specified by:
        toArray in interface CharContainer

      • toString

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