com.esri.arcgis.geoprocessing
Class GpObjectArray

java.lang.Object
  com.esri.arcgis.geoprocessing.GpObjectArray

All Implemented Interfaces:

IGpObjectArray, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GpObjectArray
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGpObjectArray

Geoprocessing Object Array object.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GpObjectArray()
Constructs a GpObjectArray using ArcGIS Engine.

GpObjectArray(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpObjectArray theGpObjectArray = (GpObjectArray) obj;

Method Summary

void	add(Object pObject) Adds an object to the array.
boolean	equals(Object o) Compare this object with another
void	esri_clone(IGpObjectArray pSrcObj) Assigns the properties of source array to this object.
static String	getClsid() getClsid.
int	getCount() The element count of the array.
Object	getObject(int element) Returns the object at the given index in the array.
int	hashCode() the hashcode for this object
void	insert(int element, Object pObject) Adds an object to the array at the specified index.
Object	next() Returns the next object at the current index in the array.
void	remove(int element) Removes the object at the specified index from the array.
void	removeAll() Removes all objects from the array.
void	replace(int element, Object pObject) Replaces the object at the specified index in the array.
void	reset() Sets the current enumeration index (used by the Next method) back to the first element in the array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GpObjectArray

public GpObjectArray()
              throws IOException,
                     UnknownHostException

Constructs a GpObjectArray using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GpObjectArray

public GpObjectArray(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GpObjectArray theGpObjectArray = (GpObjectArray) obj;

Construct a GpObjectArray using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GpObjectArray.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getCount

public int getCount()
             throws IOException,
                    AutomationException

The element count of the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

getCount in interface IGpObjectArray

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(Object pObject)
         throws IOException,
                AutomationException

Adds an object to the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

add in interface IGpObjectArray

Parameters:

pObject - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public Object getObject(int element)
                 throws IOException,
                        AutomationException

Returns the object at the given index in the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

getObject in interface IGpObjectArray

Parameters:

element - The element (in)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Sets the current enumeration index (used by the Next method) back to the first element in the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

reset in interface IGpObjectArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public Object next()
            throws IOException,
                   AutomationException

Returns the next object at the current index in the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

next in interface IGpObjectArray

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int element)
            throws IOException,
                   AutomationException

Removes the object at the specified index from the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

remove in interface IGpObjectArray

Parameters:

element - The element (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all objects from the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeAll in interface IGpObjectArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int element,
                   Object pObject)
            throws IOException,
                   AutomationException

Adds an object to the array at the specified index.

Product Availability

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

Supported Platforms

Windows

Specified by:

insert in interface IGpObjectArray

Parameters:

element - The element (in)

pObject - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replace

public void replace(int element,
                    Object pObject)
             throws IOException,
                    AutomationException

Replaces the object at the specified index in the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

replace in interface IGpObjectArray

Parameters:

element - The element (in)

pObject - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public void esri_clone(IGpObjectArray pSrcObj)
                throws IOException,
                       AutomationException

Assigns the properties of source array to this object.

Product Availability

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

Specified by:

esri_clone in interface IGpObjectArray

Parameters:

pSrcObj - A reference to a com.esri.arcgis.geoprocessing.IGpObjectArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.