com.esri.arcgis.system
Interface IStringArray

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IStringArrayProxy, Names, StrArray

public interface IStringArray

extends java.io.Serializable

Provides access to members that control string arrays.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The IStringArray interface provides methods and properties for inserting, removing and accessing elements in a StrArray via a zero-based index.

Method Summary

void	add(java.lang.String element) Add an element.
int	getCount() The element count.
java.lang.String	getElement(int index) An element in the array.
void	insert(int index, java.lang.String element) Add an element at the specified posiiton.
void	remove(int index) Removes element at the specified position.
void	removeAll() Removes all elements.
void	setElement(int index, java.lang.String element) An element in the array.

Method Detail

getCount

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

The element count.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the number of elements in the array.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElement

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

An element in the array.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or sets the element at the specified index in 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.

Parameters:

index - The index (in)

Returns:

The element

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElement

public void setElement(int index,
                       java.lang.String element)
                throws java.io.IOException,
                       AutomationException

An element in the array.

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

element - The element (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

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

Removes element at the specified position.

Supported Platforms

Windows, Solaris, Linux

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.

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 elements.

Supported Platforms

Windows, Solaris, Linux

Description

Removes all of the elements from the array.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(java.lang.String element)
         throws java.io.IOException,
                AutomationException

Add an element.

Supported Platforms

Windows, Solaris, Linux

Description

Adds the element to the end of the array.

Parameters:

element - The element (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   java.lang.String element)
            throws java.io.IOException,
                   AutomationException

Add an element at the specified posiiton.

Supported Platforms

Windows, Solaris, Linux

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.

Parameters:

index - The index (in)

element - The element (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.