com.esri.arcgis.geoprocessing
Class GPParseString

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPParseString
All Implemented Interfaces:
IGPParseString, IGPParseString2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GPParseString
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPParseString, IGPParseString2

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

Description 'Helper class used to parse strings based upon a token separator.' 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.IGPParseString
IID, IID05bebf04_93db_4b17_97bd_b158792c6625, xxDummy
 
Fields inherited from interface com.esri.arcgis.geoprocessing.IGPParseString2
IID, IID1a39705f_345b_4c6d_b5d5_aad3f5b4b218, xxDummy
 
Constructor Summary
GPParseString()
          Constructs a GPParseString using ArcGIS Engine.
GPParseString(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPParseString theGPParseString = (GPParseString) obj;
 
Method Summary
 java.lang.String checkToken(java.lang.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.
 java.lang.String doubleToString(double value)
          Returns the double value as string.
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int hashCode()
          the hashcode for this object
 void initialize(java.lang.String string, java.lang.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.
 boolean needsQuote(java.lang.String text)
          Returns if the string needs to be quoted.
 boolean nextBoolean()
          Returns the next token parsed from the string as a boolean.
 double nextDouble()
          Returns the next token parsed from the string as a double.
 int nextLong()
          Returns the next token parsed from the string as a long.
 java.lang.String nextSimpleToken()
          Returns the next simple token parsed from the string.
 java.lang.String nextToken()
          Returns the next token parsed from the string.
 java.lang.String quoteString(java.lang.String text)
          Quotes the string if it needs to be quoted.
 void release()
          Release a GPParseString.
 java.lang.String remainingText()
          Returns the remaining string.
 double stringToDouble(java.lang.String text)
          Returns the string as a doulbe value.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GPParseString

public GPParseString()
              throws java.io.IOException,
                     java.net.UnknownHostException
Constructs a GPParseString using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPParseString

public GPParseString(java.lang.Object obj)
              throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPParseString theGPParseString = (GPParseString) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

initialize

public void initialize(java.lang.String string,
                       java.lang.String separator)
                throws java.io.IOException,
                       AutomationException
Initializes the geoprocessing parse string object with the string to be parsed and the string used to separate tokens.

Specified by:
initialize in interface IGPParseString
Specified by:
initialize in interface IGPParseString2
Parameters:
string - The string (in)
separator - The separator (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextToken

public java.lang.String nextToken()
                           throws java.io.IOException,
                                  AutomationException
Returns the next token parsed from the string.

Specified by:
nextToken in interface IGPParseString
Specified by:
nextToken in interface IGPParseString2
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextSimpleToken

public java.lang.String nextSimpleToken()
                                 throws java.io.IOException,
                                        AutomationException
Returns the next simple token parsed from the string.

Specified by:
nextSimpleToken in interface IGPParseString
Specified by:
nextSimpleToken in interface IGPParseString2
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNextTokenQuoted

public boolean isNextTokenQuoted()
                          throws java.io.IOException,
                                 AutomationException
Returns whether the next token to be parsed is enclosed in quotation marks.

Specified by:
isNextTokenQuoted in interface IGPParseString
Specified by:
isNextTokenQuoted in interface IGPParseString2
Returns:
The quoted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkToken

public java.lang.String checkToken(java.lang.String inChar,
                                   boolean[] pInQuote,
                                   boolean[] pTokenDone)
                            throws java.io.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.

Specified by:
checkToken in interface IGPParseString
Specified by:
checkToken in interface IGPParseString2
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remainingText

public java.lang.String remainingText()
                               throws java.io.IOException,
                                      AutomationException
Returns the remaining string.

Specified by:
remainingText in interface IGPParseString2
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextDouble

public double nextDouble()
                  throws java.io.IOException,
                         AutomationException
Returns the next token parsed from the string as a double.

Specified by:
nextDouble in interface IGPParseString2
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextLong

public int nextLong()
             throws java.io.IOException,
                    AutomationException
Returns the next token parsed from the string as a long.

Specified by:
nextLong in interface IGPParseString2
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextBoolean

public boolean nextBoolean()
                    throws java.io.IOException,
                           AutomationException
Returns the next token parsed from the string as a boolean.

Specified by:
nextBoolean in interface IGPParseString2
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

needsQuote

public boolean needsQuote(java.lang.String text)
                   throws java.io.IOException,
                          AutomationException
Returns if the string needs to be quoted.

Specified by:
needsQuote in interface IGPParseString2
Parameters:
text - The text (in)
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

quoteString

public java.lang.String quoteString(java.lang.String text)
                             throws java.io.IOException,
                                    AutomationException
Quotes the string if it needs to be quoted.

Specified by:
quoteString in interface IGPParseString2
Parameters:
text - The text (in)
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stringToDouble

public double stringToDouble(java.lang.String text)
                      throws java.io.IOException,
                             AutomationException
Returns the string as a doulbe value.

Specified by:
stringToDouble in interface IGPParseString2
Parameters:
text - The text (in)
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

doubleToString

public java.lang.String doubleToString(double value)
                                throws java.io.IOException,
                                       AutomationException
Returns the double value as string.

Specified by:
doubleToString in interface IGPParseString2
Parameters:
value - The value (in)
Returns:
The token
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.