Interface AtomCollection

All Superinterfaces:
BasicCollection<Atom>, Iterable<Atom>
All Known Subinterfaces:
AtomSet, Partition.OtherAtomsCollection
public interface AtomCollection extends BasicCollection<Atom>
AtomCollection represents a collection of Atom objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(Atom atom)
    Returns true if the given atom is in this collection
    boolean
    isEmpty()
    Returns true if this collection is empty.
    Iterator<Atom>
    iterator()
    Return an iterator to visit each atom in this collection.
    int
    size()
    Return the number of atoms in this collection

    Methods inherited from interface Iterable

    forEach, spliterator

  • Method Details

    • contains

      boolean contains(Atom atom)
      Returns true if the given atom is in this collection
      Specified by:
      contains in interface BasicCollection<Atom>
      Returns:
      true if the given atom is in this collection

    • size

      int size()
      Return the number of atoms in this collection
      Returns:
      the number of atoms in this collection.

    • isEmpty

      boolean isEmpty()
      Returns true if this collection is empty.
      Specified by:
      isEmpty in interface BasicCollection<Atom>
      Returns:
      true if this collection is empty.

    • iterator

      Iterator<Atom> iterator()
      Return an iterator to visit each atom in this collection.
      Specified by:
      iterator in interface BasicCollection<Atom>
      Specified by:
      iterator in interface Iterable<Atom>
      Returns:
      an Iterator to visit each atom in this collection.