com.esri.arcgis.geoprocessing
Class EnumBSTR

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

All Implemented Interfaces:

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

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

COM Class 'EnumBSTR'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'Enumeration of multiple strings.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geoprocessing.IBStringArray

IID, IID0c39cb39_fd27_49da_89d2_fc3f017064f9, xxDummy

Fields inherited from interface com.esri.arcgis.system.IEnumBSTR

IID, IID18a45ba8_1266_11d1_86ad_0000f8751720, xxDummy

Constructor Summary

EnumBSTR()
Constructs a EnumBSTR using ArcGIS Engine.

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

Method Summary

void	addString(java.lang.String str) Adds a string to the array.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
int	getCount() The size of the array.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getString(int index) The string at the specified index in the array.
int	hashCode() the hashcode for this object
void	insertString(int index, java.lang.String str) Adds a string to the array at the specified index.
java.lang.String	next() Obtains the next string in the list.
void	release() Release a EnumBSTR.
void	removeAll() Removes all strings from the array.
void	removeString(int index) Removes a string from the array.
void	replaceString(int index, java.lang.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

Constructor Detail

EnumBSTR

public EnumBSTR()
         throws java.io.IOException,
                java.net.UnknownHostException

Constructs a EnumBSTR using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EnumBSTR

public EnumBSTR(java.lang.Object obj)
         throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a EnumBSTR.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getCount

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

The size of the array.

Specified by:

getCount in interface IBStringArray

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getString

public java.lang.String getString(int index)
                           throws java.io.IOException,
                                  AutomationException

The string at the specified index in the array.

Specified by:

getString in interface IBStringArray

Parameters:

index - The index (in)

Returns:

The str

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addString

public void addString(java.lang.String str)
               throws java.io.IOException,
                      AutomationException

Adds a string to the array.

Specified by:

addString in interface IBStringArray

Parameters:

str - The str (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertString

public void insertString(int index,
                         java.lang.String str)
                  throws java.io.IOException,
                         AutomationException

Adds a string to the array at the specified index.

Specified by:

insertString in interface IBStringArray

Parameters:

index - The index (in)

str - The str (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeString

public void removeString(int index)
                  throws java.io.IOException,
                         AutomationException

Removes a string from the array.

Specified by:

removeString in interface IBStringArray

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all strings from the array.

Specified by:

removeAll in interface IBStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replaceString

public void replaceString(int index,
                          java.lang.String str)
                   throws java.io.IOException,
                          AutomationException

Replaces a string in the array.

Specified by:

replaceString in interface IBStringArray

Parameters:

index - The index (in)

str - The str (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

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

Obtains the next string in the list.

Specified by:

next in interface IEnumBSTR

Returns:

The pBSTR

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

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

Specified by:

reset in interface IEnumBSTR

Throws:

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

AutomationException - If the ArcObject component throws an exception.