Package com.sun.jna.platform.win32.COM

Klasse IComEnumVariantIterator

java.lang.Object

com.sun.jna.platform.win32.COM.IComEnumVariantIterator

Alle implementierten Schnittstellen:

Closeable, AutoCloseable, Iterable<Variant.VARIANT>, Iterator<Variant.VARIANT>

public class IComEnumVariantIterator
extends Object
implements Iterable<Variant.VARIANT>, Iterator<Variant.VARIANT>, Closeable

Wrapper for an EnumVariant Iteration. The usecase is a for-loop in the style:

 // Aquire an IDispatch, that has a new NewEnum Property (DISPID_NEWENUM)
 for(VARIANT v: IComEnumVariantIterator.wrap(dispatch)) {
      // Work with the acquired Variant
      // ...
      // Finally free it
      OleAuto.INSTANCE.VariantClear(v);
 }
 

The IComEnumVariantIterator iterator closes the enumeration it wraps after the enumeration is exhausted or when the iterator is GCed, whatever happens earlier.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
IComEnumVariantIterator(EnumVariant backingIteration)	IComEnumVariantIterator wraps the supplied EnumVariant and exposes that as an Iterable<Variant.VARIANT>/Iterator<Variant.VARIANT>.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	close()
protected void	finalize()
boolean	hasNext()
Iterator<Variant.VARIANT>	iterator()
Variant.VARIANT	next()
void	remove()
static IComEnumVariantIterator	wrap(IDispatch dispatch)	Helper to get new enumeration from an IDispatch.

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden java.lang.Iterable

forEach, spliterator

Von Schnittstelle geerbte Methoden java.util.Iterator

forEachRemaining

Konstruktordetails

IComEnumVariantIterator

public IComEnumVariantIterator(EnumVariant backingIteration)

IComEnumVariantIterator wraps the supplied EnumVariant and exposes that as an Iterable<Variant.VARIANT>/Iterator<Variant.VARIANT>. The class takes possion of the supplied EnumVariant. So the EnumVariant is Released when the enumeration is exhausted or the Iterator is GCed.

Parameter:

backingIteration -

Methodendetails

wrap

public static IComEnumVariantIterator wrap(IDispatch dispatch)

Helper to get new enumeration from an IDispatch.

This expects, that the supplied IDispatch has a property identified by a OaIdl.DISPID of OaIdl.DISPID_NEWENUM

Parameter:

dispatch - IDispatch to be analysed

Gibt zurück:

IComEnumVariantIterator wrapping the enumeration queried from the supplied object

hasNext

public boolean hasNext()

Angegeben von:

hasNext in Schnittstelle Iterator<Variant.VARIANT>

next

public Variant.VARIANT next()

Angegeben von:

next in Schnittstelle Iterator<Variant.VARIANT>

close

public void close()

Angegeben von:

close in Schnittstelle AutoCloseable

Angegeben von:

close in Schnittstelle Closeable

finalize

protected void finalize()
                 throws Throwable

Setzt außer Kraft:

finalize in Klasse Object

Löst aus:

Throwable

iterator

public Iterator<Variant.VARIANT> iterator()

Angegeben von:

iterator in Schnittstelle Iterable<Variant.VARIANT>

remove

public void remove()

Angegeben von:

remove in Schnittstelle Iterator<Variant.VARIANT>