com.esri.arcgis.geoprocessing
Class EnumBSTR

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

All Implemented Interfaces:

IBStringArray, com.esri.arcgis.interop.RemoteObjRef, IEnumBSTR, Serializable

public class EnumBSTR
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBStringArray, IEnumBSTR

Enumeration of multiple strings.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

EnumBSTR()
Constructs a EnumBSTR using ArcGIS Engine.

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

Method Summary

void	addString(String str) Adds a string to the array.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() The size of the array.
String	getString(int index) The string at the specified index in the array.
int	hashCode() the hashcode for this object
void	insertString(int index, String str) Adds a string to the array at the specified index.
String	next() Obtains the next string in the list.
void	removeAll() Removes all strings from the array.
void	removeString(int index) Removes a string from the array.
void	replaceString(int index, String str) Replaces a string in the array.
void	reset() Resets the string so the next returned string is the first.

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

EnumBSTR

public EnumBSTR()
         throws IOException,
                UnknownHostException

Constructs a EnumBSTR using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

EnumBSTR

public EnumBSTR(Object obj)
         throws IOException

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

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

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 size of the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

getCount in interface IBStringArray

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getString

public String getString(int index)
                 throws IOException,
                        AutomationException

The string at the specified index in the array.

Product Availability

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

Specified by:

getString in interface IBStringArray

Parameters:

index - The index (in)

Returns:

The str

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addString

public void addString(String str)
               throws IOException,
                      AutomationException

Adds a string to the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

addString in interface IBStringArray

Parameters:

str - The str (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertString

public void insertString(int index,
                         String str)
                  throws IOException,
                         AutomationException

Adds a string to the array at the specified index.

Product Availability

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

Supported Platforms

Windows

Specified by:

insertString in interface IBStringArray

Parameters:

index - The index (in)

str - The str (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeString

public void removeString(int index)
                  throws IOException,
                         AutomationException

Removes a string from the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeString in interface IBStringArray

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 strings from the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

removeAll in interface IBStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replaceString

public void replaceString(int index,
                          String str)
                   throws IOException,
                          AutomationException

Replaces a string in the array.

Product Availability

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

Supported Platforms

Windows

Specified by:

replaceString in interface IBStringArray

Parameters:

index - The index (in)

str - The str (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public String next()
            throws IOException,
                   AutomationException

Obtains the next string in the list.

Description

The Next method returns the next string in the enumerator. An empty string is returned by Next when there are no more strings to fetch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface IEnumBSTR

Returns:

The pBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the string so the next returned string is the first.

Description

The Reset method resets the enumerator so that the next call to the Next method returns the first string in the enumerator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.