Class LayoutModelIterator

  • All Implemented Interfaces:
    java.util.Iterator<Layout>

    public class LayoutModelIterator
    extends java.lang.Object
    implements java.util.Iterator<Layout>
    An Iterator returning Layout objects that hides the details of using LayoutModel's indexing methods.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.math.BigInteger getIndex()
      Returns the LayoutModel index of the item that was just returned via next().
      java.math.BigInteger getNextIndex()
      Returns the LayoutModel index of the next item that will be returned via next().
      java.math.BigInteger getPreviousIndex()
      Returns the LayoutModel index of the previous item that was returned via next().
      boolean hasNext()  
      Layout next()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.util.Iterator

        forEachRemaining, remove
    • Constructor Detail

      • LayoutModelIterator

        public LayoutModelIterator​(LayoutModel layoutModel)
      • LayoutModelIterator

        public LayoutModelIterator​(LayoutModel layoutModel,
                                   java.math.BigInteger startIndex)
    • Method Detail

      • getIndex

        public java.math.BigInteger getIndex()
        Returns the LayoutModel index of the item that was just returned via next().
        Returns:
        index of the last Layout item returned.
      • getNextIndex

        public java.math.BigInteger getNextIndex()
        Returns the LayoutModel index of the next item that will be returned via next().
        Returns:
        index of the next Layout item returned, or null if no additional items are present
      • getPreviousIndex

        public java.math.BigInteger getPreviousIndex()
        Returns the LayoutModel index of the previous item that was returned via next().
        Returns:
        index of the previous Layout item returned, or null if this iterator hasn't been used yet.
      • hasNext

        public boolean hasNext()
        Specified by:
        hasNext in interface java.util.Iterator<Layout>
      • next

        public Layout next()
        Specified by:
        next in interface java.util.Iterator<Layout>