com.esri.arcgis.system
Class ISetProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.system.ISetProxy

All Implemented Interfaces:

java.io.Externalizable, ISet, java.io.Serializable

public class ISetProxy

extends Dispatch

implements ISet, java.io.Serializable

Provides access to members that control a simple set of objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	ISetProxy() For internal use only
	ISetProxy(java.lang.Object obj)
protected	ISetProxy(java.lang.Object obj, java.lang.String iid)
	ISetProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	ISetProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	add(java.lang.Object unk) Adds an object to the set.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
boolean	find(java.lang.Object unk) Searches for the object in the set.
int	getCount() The element count of the set.
java.lang.Object	next() Returns the next object in the set.
void	remove(java.lang.Object unk) Removes the object from the set.
void	removeAll() Removes all objects from the set.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	reset() Resets the set for enumerating through the objects with Next.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

ISetProxy

public ISetProxy(java.lang.String CLSID,
                 java.lang.String host,
                 AuthInfo authInfo)
          throws java.net.UnknownHostException,
                 java.io.IOException

ISetProxy

public ISetProxy()

For internal use only

ISetProxy

public ISetProxy(java.lang.Object obj)
          throws java.io.IOException

ISetProxy

protected ISetProxy(java.lang.Object obj,
                    java.lang.String iid)
             throws java.io.IOException

ISetProxy

protected ISetProxy(java.lang.String CLSID,
                    java.lang.String iid,
                    java.lang.String host,
                    AuthInfo authInfo)
             throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

add

public void add(java.lang.Object unk)
         throws java.io.IOException,
                AutomationException

Description copied from interface: ISet

Adds an object to the set.

Supported Platforms

Windows, Solaris, Linux

Description

Adds the specified object to the Set. If you add the same object to a Set twice, no error occurs but the resulting Set has only one reference to the object.

Remarks

The order in which objects are added to the Set using Add is not guaranteed to be the same order in which they are returned by the Next method.

When adding an object to a Set, you are merely adding a new reference to the object not copying it. The reference is released when the Set is destroyed or the object is removed. For example, if you add geodatabase features to a Set (or an Array) using a feature cursor, you must use a non-recycling cursor, otherwise the memory location of the previous feature is overwritten.

Specified by:

add in interface ISet

Parameters:

unk - A reference to another Object (IUnknown) (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

remove

public void remove(java.lang.Object unk)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ISet

Removes the object from the set.

Supported Platforms

Windows, Solaris, Linux

Description

Removes the reference to the specified object from the Set.

Specified by:

remove in interface ISet

Parameters:

unk - A reference to another Object (IUnknown) (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ISet

Removes all objects from the set.

Supported Platforms

Windows, Solaris, Linux

Description

Removes all references to objects from the Set.

Specified by:

removeAll in interface ISet

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

find

public boolean find(java.lang.Object unk)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISet

Searches for the object in the set.

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether a reference to the specified object has been added to the Set with the Add method.

Specified by:

find in interface ISet

Parameters:

unk - A reference to another Object (IUnknown) (in)

Returns:

The found

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

next

public java.lang.Object next()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: ISet

Returns the next object in the set.

Supported Platforms

Windows, Solaris, Linux

Description

The Next method returns the next object in the Set.

Remarks

The order that objects are returned from the Set object using the Next method is not guaranteed to be the same order as they were passed into the Add method. However, the Next method will return the objects in the same order.

Specified by:

next in interface ISet

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Description copied from interface: ISet

Resets the set for enumerating through the objects with Next.

Supported Platforms

Windows, Solaris, Linux

Description

The Reset method resets the Set so that the next call to the Next method returns the first object in the Set.

Remarks

The order that objects are returned from the Set object using the Next method is not guaranteed to be the same order as they were passed into the Add method. However, the Next method will return the objects in the same order.

Specified by:

reset in interface ISet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: ISet

The element count of the set.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the number of objects in the Set.

Specified by:

getCount in interface ISet

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.