JdapiObjectListIterator

java.lang.Object
- oracle.forms.jdapi.JdapiObjectListIterator

All Implemented Interfaces:

java.util.Iterator, JdapiIterator
```
class JdapiObjectListIterator
extends java.lang.Object
implements JdapiIterator
```
Forms object iterator class is an iterator of a list of Forms objects of a given type (as defined at runtime). It is a unidirectional iterator for objects of that type within a given context (e.g. Items of a Block).
This class supports the JDK1.2 Iterator interface . It also supports the bidirectionality of the JDK1.2 ListIterator (but doesn't explicitly support that interface).
The typical way to use this (as JDK1.2 Iterator) is as follows:
```
    while(items.hasNext()) {
      JdapiModule mod = (JdapiModule)modules.next();
      // do something with module mod...
    }
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
	`JdapiObjectListIterator(JdapiObject obj)` Constructor for creating an iterator to iterate through objects from a given one.
	`JdapiObjectListIterator(JdapiObjectListIterator other)` Copy constructor.
`protected`	`JdapiObjectListIterator(long pd2fctx, long pd2fob, int property, long d2ffox)` Constructor for creating an iterator based on a property of an object.
`protected`	`JdapiObjectListIterator(long pd2fctx, long pd2fob, long d2ffox)` Constructor for creating an iterator at a given starting object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a copy of the iterator at the current position.
`void`	`goLast()` Moves the iterator to the end of the list.
`void`	`goStart()` Moves the iterator to the start of the list.
`boolean`	`hasMoreElements()` Returns true if the iteration has more elements.
`boolean`	`hasNext()` Returns true if the iteration has more elements (JDK1.2 iterator style).
`boolean`	`hasPrevious()` Returns true if the iteration has previous elements (JDK1.2 list iterator style).
`java.lang.Object`	`next()` Gets the next object (JDK1.2 iterator style).
`java.lang.Object`	`nextElement()` Gets the next object.
`java.lang.Object`	`previous()` Gets the previous object (JDK1.2 list iterator style).
`void`	`remove()` Removes the current object from the iteration.
`java.lang.String`	`toString()` Get a string representation of the current state of the object.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - JdapiObjectListIterator
```
public JdapiObjectListIterator(JdapiObject obj)
```
    Constructor for creating an iterator to iterate through objects from a given one. This may give you an iterator that does not start at the begining of the list (if 'obj' is not the first object).
    
    Parameters:
    
    obj - Object at which to start iterating from, note, the JdapiObjectListIterator will return this as it's first object.
  - JdapiObjectListIterator
```
protected JdapiObjectListIterator(long pd2fctx,
                                  long pd2fob,
                                  int property,
                                  long d2ffox)
```
    Constructor for creating an iterator based on a property of an object. e.g. used when creating an iterator for the blocks on a form. For internal library use only. The iterator will always start at the begining of the list.
    
    Parameters:
    
    pd2fctx - Forms API context pointer
    
    pd2fob - Base object from which to get property to iterate
    
    property - Property ID to get object to iterate
    
    d2ffox - Forms object type to create
  - JdapiObjectListIterator
```
protected JdapiObjectListIterator(long pd2fctx,
                                  long pd2fob,
                                  long d2ffox)
```
    Constructor for creating an iterator at a given starting object. For internal library use only. This may give you an iterator that does not start at the begining of the list (if 'obj' is not the first object).
    
    Parameters:
    
    pd2fctx - Forms API context pointer
    
    pd2fob - Object at which to start iterating from, note, the JdapiObjectListIterator will return this object as it's first object.
    
    d2ffox - Forms object type to create
  - JdapiObjectListIterator
```
public JdapiObjectListIterator(JdapiObjectListIterator other)
```
    Copy constructor.
    
    Parameters:
    
    other - Iterator to copy
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Get a string representation of the current state of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representation of the current state
  - clone
```
public java.lang.Object clone()
```
    Creates a copy of the iterator at the current position.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    JdapiObjectListIterator on the same list at the current position
  - goLast
```
public void goLast()
```
    Moves the iterator to the end of the list. Useful if you want to step backwards through a list. Be warned that this is potentially an expensive operation as it needs to step though to the end of the list (time taken will depend on where you are in the list).
    
    Specified by:
    
    goLast in interface JdapiIterator
  - goStart
```
public void goStart()
```
    Moves the iterator to the start of the list. Be warned that this potentially an expensive operation as it needs to step though to the start of the list (time taken will depend on where you are in the list).
    
    Specified by:
    
    goStart in interface JdapiIterator
  - hasMoreElements
```
public boolean hasMoreElements()
```
    Returns true if the iteration has more elements.
    
    Returns:
    
    If the iteration has more elements
  - hasNext
```
public boolean hasNext()
```
    Returns true if the iteration has more elements (JDK1.2 iterator style).
    
    Specified by:
    
    hasNext in interface java.util.Iterator
    
    Specified by:
    
    hasNext in interface JdapiIterator
    
    Returns:
    
    If the iteration has more elements
  - hasPrevious
```
public boolean hasPrevious()
```
    Returns true if the iteration has previous elements (JDK1.2 list iterator style).
    
    Specified by:
    
    hasPrevious in interface JdapiIterator
    
    Returns:
    
    If the iteration has previous elements
  - nextElement
```
public java.lang.Object nextElement()
```
    Gets the next object.
    
    Returns:
    
    The next object, null if there are none
  - next
```
public java.lang.Object next()
```
    Gets the next object (JDK1.2 iterator style).
    
    Specified by:
    
    next in interface java.util.Iterator
    
    Specified by:
    
    next in interface JdapiIterator
    
    Returns:
    
    The next object, null if there are none
  - previous
```
public java.lang.Object previous()
```
    Gets the previous object (JDK1.2 list iterator style).
    
    Specified by:
    
    previous in interface JdapiIterator
    
    Returns:
    
    The previous object, null if there are none
  - remove
```
public void remove()
```
    Removes the current object from the iteration. You may not call this method twice on the same object in the iteration. This is the method you should use if you want to remove objects from within an iteration and continue to go through the iteration. If you destroy an object in the iteration any other way, the iterator will probably fail.
    If the iterator is not positioned at the first element of the list, it will position itself there before doing the remove. This allows you to write code like:
```
   while(iter.hasNext()) {
     iter.remove();
   }
 
```
    Specified by:
    
    remove in interface java.util.Iterator
    
    Specified by:
    
    remove in interface JdapiIterator

Class JdapiObjectListIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Detail

JdapiObjectListIterator

JdapiObjectListIterator

JdapiObjectListIterator

JdapiObjectListIterator

Method Detail

toString

clone

goLast

goStart

hasMoreElements

hasNext

hasPrevious

nextElement

next

previous

remove