com.esri.arcgis.system
Class IEnumNamedIDProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.system.IEnumNamedIDProxy
All Implemented Interfaces:
IEnumNamedID, Externalizable, Serializable

public class IEnumNamedIDProxy
extends com.esri.arcgis.interop.Dispatch
implements IEnumNamedID, Serializable

Provides access to members that enumerate over a set of named IDs.

Description

IEnumNamedID, which is used by the Paper object of esriOutput, provides browsing over a set of ID-name pairs. The ID is a long integer returned by the Next method. The name is a string returned as an ouput parameter of Next. When there are no more pairs to fetch, Next returns an empty name string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IEnumNamedIDProxy()
           
  IEnumNamedIDProxy(Object obj)
           
protected IEnumNamedIDProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int next(String[] nextName)
          Returns the next name-ID pair in the set.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void reset()
          Resets internal cursor so that the next call to Next returns the first pair in the set.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IEnumNamedIDProxy

public IEnumNamedIDProxy()

IEnumNamedIDProxy

public IEnumNamedIDProxy(Object obj)
                  throws IOException
Throws:
IOException

IEnumNamedIDProxy

protected IEnumNamedIDProxy(Object obj,
                            String iid)
                     throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

next

public int next(String[] nextName)
         throws IOException,
                AutomationException
Returns the next name-ID pair in the set.

Description

The Next method returns the next ID and name pair in the enumerator. When there are no more pairs to fetch, Next returns an empty name string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
next in interface IEnumNamedID
Parameters:
nextName - The nextName (out: use single element array)
Returns:
The identifier
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets internal cursor so that the next call to Next returns the first pair in the set.

Description

The Reset method resets the enumerator so that the next call to the Next method returns the first ID and name pair in the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
reset in interface IEnumNamedID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException