com.esri.arcgis.geoprocessing
Class EnumGPEnvironment

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

All Implemented Interfaces:

IEnumGPEnvironment, com.esri.arcgis.interop.RemoteObjRef, IArray, IArray2, Serializable

public class EnumGPEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArray, IArray2, IEnumGPEnvironment

Enumeration of multiple geoprocessing environment objects.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

EnumGPEnvironment()
Constructs a EnumGPEnvironment using ArcGIS Engine.

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

Method Summary

void	add(Object unk) Adds an object to the array.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() The element count of the array.
Object	getElement(int index) Searches for the object in the array.
int	hashCode() the hashcode for this object
void	insert(int index, Object unk) Adds an object to the array at the specified index.
IGPEnvironment	next() Returns the next geoprocessing environment in the enumeration.
void	remove(int index) Removes an object from the array.
void	removeAll() Removes all objects from the array.
void	replace(int index, Object unk) Replaces an object in the array.
void	reset() Resets the current position of the enumeration.

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

EnumGPEnvironment

public EnumGPEnvironment()
                  throws IOException,
                         UnknownHostException

Constructs a EnumGPEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

EnumGPEnvironment

public EnumGPEnvironment(Object obj)
                  throws IOException

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

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

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.

Description

Returns the number of elements in the array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IArray

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

public Object getElement(int index)
                  throws IOException,
                         AutomationException

Searches for the object in the array.

Product Availability

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

Specified by:

getElement in interface IArray

Parameters:

index - The index (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(Object unk)
         throws IOException,
                AutomationException

Adds an object to the array.

Description

Adds the element to the end of the array.

Remarks

When adding an object to an Array, you are merely adding a new reference to the object not copying it. The reference is released when the Array is destroyed or the object is removed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IArray

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   Object unk)
            throws IOException,
                   AutomationException

Adds an object to the array at the specified index.

Description

Adds the element to the array at the specified index. The element at the beginning or the array has an index of 0, and the element at the end of the array has in index of Count - 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

insert in interface IArray

Parameters:

index - The index (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException

Removes an object from the array.

Description

Removes the element at the specified index from the array. The element at the beginning or the array has an index of 0, and the element at the end of the array has in index of Count - 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IArray

Parameters:

index - The index (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.

Description

Removes all of the elements from the array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAll in interface IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replace

public void replace(int index,
                    Object unk)
             throws IOException,
                    AutomationException

Replaces an object in the array.

Description

Replaces the element at the specified index in the array with the specified element. The element at the beginning or the array has an index of 0, and the element at the end of the array has in index of Count - 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

replace in interface IArray2

Parameters:

index - The index (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public IGPEnvironment next()
                    throws IOException,
                           AutomationException

Returns the next geoprocessing environment in the enumeration.

Product Availability

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

Supported Platforms

Windows

Specified by:

next in interface IEnumGPEnvironment

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the current position of the enumeration.

Product Availability

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

Supported Platforms

Windows

Specified by:

reset in interface IEnumGPEnvironment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.