com.inductiveautomation.ignition.designer.findreplace

Class SearchObjectCursor

java.lang.Object

com.inductiveautomation.ignition.designer.findreplace.SearchObjectCursor

Direct Known Subclasses:

ClientScriptSearchProvider.MenuNodeCursor, ComponentCursor, ComponentTermCursor, SearchObjectAggregator, TagPropertyIterator, TagSearchProvider.AlarmIterator, TagSearchProvider.AlarmIterator.AlarmPropertyIterator, TagSearchProvider.ComplexTagIterator, TagSearchProvider.ComplexTagIterator.ParameterIterator, TagSearchProvider.OverridesIterator, TagSearchProvider.ScriptIterator, TagSearchProvider.TagSearchIterator, TemplateCursor, WindowCursor

public abstract class SearchObjectCursor
extends java.lang.Object

A simplified adaptation of iterator that is made to work with a SearchObjectAggregator. The main difference between this and an Iterator, besides the lack of hasNext() and remove(), is that a SearchObjectCursor is allowed to return either SearchObjects or more SearchObjectCursors, and the SearchObjectAggregator will sort it all out.

Constructor Summary

Constructors

Constructor and Description
SearchObjectCursor()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	next() Gets the next search object, which might be a SearchObject or a SearchObjectCursor.
static SearchObjectCursor	of(SearchObject... sos)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchObjectCursor

public SearchObjectCursor()

Method Detail

next

public abstract java.lang.Object next()

Gets the next search object, which might be a SearchObject or a SearchObjectCursor. Null is returned at the end of the stream to signify that the cursor is exhausted.

of

public static SearchObjectCursor of(SearchObject... sos)