com.esri.arcgis.geoprocessing
Interface IGPParseString

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPParseString

public interface IGPParseString
extends Serializable

Provides access to the properties/methods of a geoprocessing parse string object.

Superseded By

IGPParseString2

Product Availability

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

Method Summary

String	checkToken(String inChar, boolean[] pInQuote, boolean[] pTokenDone) Builds a string, one character at a time, returning whether that character is quoted and whether that character is the end of delimited token.
void	initialize(String string, String separator) Initializes the geoprocessing parse string object with the string to be parsed and the string used to separate tokens.
boolean	isNextTokenQuoted() Returns whether the next token to be parsed is enclosed in quotation marks.
String	nextSimpleToken() Returns the next simple token parsed from the string.
String	nextToken() Returns the next token parsed from the string.

Method Detail

initialize

void initialize(String string,
                String separator)
                throws IOException,
                       AutomationException

Initializes the geoprocessing parse string object with the string to be parsed and the string used to separate tokens.

Product Availability

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

Supported Platforms

Windows

Parameters:

string - The string (in)

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextToken

String nextToken()
                 throws IOException,
                        AutomationException

Returns the next token parsed from the string.

Product Availability

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

Supported Platforms

Windows

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextSimpleToken

String nextSimpleToken()
                       throws IOException,
                              AutomationException

Returns the next simple token parsed from the string.

Product Availability

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

Supported Platforms

Windows

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNextTokenQuoted

boolean isNextTokenQuoted()
                          throws IOException,
                                 AutomationException

Returns whether the next token to be parsed is enclosed in quotation marks.

Product Availability

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

Supported Platforms

Windows

Returns:

The quoted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkToken

String checkToken(String inChar,
                  boolean[] pInQuote,
                  boolean[] pTokenDone)
                  throws IOException,
                         AutomationException

Builds a string, one character at a time, returning whether that character is quoted and whether that character is the end of delimited token.

Product Availability

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

Supported Platforms

Windows

Parameters:

inChar - The inChar (in)

pInQuote - The pInQuote (out: use single element array)

pTokenDone - The pTokenDone (out: use single element array)

Returns:

The pToken

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.