com.esri.arcgis.system

Interface IJSONReader

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IJSONReader2, IJSONReader3

All Known Implementing Classes:

IJSONReader2Proxy, IJSONReader3Proxy, IJSONReaderProxy, JSONReader

public interface IJSONReader
extends java.io.Serializable

COM Interface 'IJSONReader'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'Provides access to Sequential JSON Reader.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID48105a80_e0dc_4d69_bb61_3df74cafa52c
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
int	findProperties(IStringArray propnames) Reads current object until one of property names matches.
boolean	findProperty(java.lang.String propname) Reads current object until property name matches or object ends.
int	getCurrentTokenType() Obtains type of current token.
IStream	getStream() Obtains underlying stream.
boolean	isBoolean() Indicates true if current token is a property value or array value of boolean type.
boolean	isEndOfArray() Indicates true if current token is ']'.
boolean	isEndOfObject() Indicates true if current token is '}'.
boolean	isNull() Indicates true if current token is a property value or array value and equals to null.
boolean	isNumber() Indicates true if current token is a property value or array value of numeric type.
boolean	isStartOfArray() Indicates true if current token is '['.
boolean	isStartOfObject() Indicates true if current token is '{'.
boolean	isString() Indicates true if current token is a property value or array value of type string.
void	read() Reads next JSON token.
void	readFrom(IStream inputStream) Specifies input stream.
void	readFromString(java.lang.String text) Specifies input as string.
java.lang.String	readPropertyName() Obtains property name.
java.lang.Object	readValue() Obtains array or property value as Variant.
boolean	readValueAsBoolean() Obtains array or property value as boolean.
java.util.Date	readValueAsDate() Obtains property or array value as date.
double	readValueAsDouble() Obtains property or array value as number.
int	readValueAsLong() Obtains property or array value as number.
java.lang.String	readValueAsString() Obtains property or array value as string.
void	skipUntilArrayEnds() Skips the rest of the current object, including closing bracket.
void	skipUntilObjectEnds() Skips the rest of the current object, including closing bracket.

Field Detail

IID48105a80_e0dc_4d69_bb61_3df74cafa52c

static final int IID48105a80_e0dc_4d69_bb61_3df74cafa52c

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

readFrom

void readFrom(IStream inputStream)
       throws java.io.IOException,
              AutomationException

Specifies input stream.

Parameters:

inputStream - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readFromString

void readFromString(java.lang.String text)
             throws java.io.IOException,
                    AutomationException

Specifies input as string.

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStream

IStream getStream()
           throws java.io.IOException,
                  AutomationException

Obtains underlying stream.

Returns:

A reference to a com.esri.arcgis.system.IStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

read

void read()
   throws java.io.IOException,
          AutomationException

Reads next JSON token.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentTokenType

int getCurrentTokenType()
                 throws java.io.IOException,
                        AutomationException

Obtains type of current token.

Returns:

A com.esri.arcgis.system.JSONTokenType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStartOfObject

boolean isStartOfObject()
                 throws java.io.IOException,
                        AutomationException

Indicates true if current token is '{'.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEndOfObject

boolean isEndOfObject()
               throws java.io.IOException,
                      AutomationException

Indicates true if current token is '}'.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStartOfArray

boolean isStartOfArray()
                throws java.io.IOException,
                       AutomationException

Indicates true if current token is '['.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEndOfArray

boolean isEndOfArray()
              throws java.io.IOException,
                     AutomationException

Indicates true if current token is ']'.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isString

boolean isString()
          throws java.io.IOException,
                 AutomationException

Indicates true if current token is a property value or array value of type string.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isNumber

boolean isNumber()
          throws java.io.IOException,
                 AutomationException

Indicates true if current token is a property value or array value of numeric type.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBoolean

boolean isBoolean()
           throws java.io.IOException,
                  AutomationException

Indicates true if current token is a property value or array value of boolean type.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isNull

boolean isNull()
        throws java.io.IOException,
               AutomationException

Indicates true if current token is a property value or array value and equals to null.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readValue

java.lang.Object readValue()
                    throws java.io.IOException,
                           AutomationException

Obtains array or property value as Variant. Advances to the next token.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readPropertyName

java.lang.String readPropertyName()
                           throws java.io.IOException,
                                  AutomationException

Obtains property name. Advances to the next token.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readValueAsString

java.lang.String readValueAsString()
                            throws java.io.IOException,
                                   AutomationException

Obtains property or array value as string. Advances to the next token. If property value cannot be coerced to string, returns E_FAIL.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readValueAsLong

int readValueAsLong()
             throws java.io.IOException,
                    AutomationException

Obtains property or array value as number. Advances to the next token. If property value cannot be coerced to long, returns E_FAIL.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readValueAsDouble

double readValueAsDouble()
                  throws java.io.IOException,
                         AutomationException

Obtains property or array value as number. Advances to the next token. If property value cannot be coerced to double, returns E_FAIL.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readValueAsBoolean

boolean readValueAsBoolean()
                    throws java.io.IOException,
                           AutomationException

Obtains array or property value as boolean. Advances to the next token. If property value cannot be coerced to boolean, returns E_FAIL.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readValueAsDate

java.util.Date readValueAsDate()
                        throws java.io.IOException,
                               AutomationException

Obtains property or array value as date. Advances to the next token. If property value cannot be coerced to datetime, returns E_FAIL.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findProperty

boolean findProperty(java.lang.String propname)
              throws java.io.IOException,
                     AutomationException

Reads current object until property name matches or object ends. Case is ignored.

Parameters:

propname - The propname (in)

Returns:

The found

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findProperties

int findProperties(IStringArray propnames)
            throws java.io.IOException,
                   AutomationException

Reads current object until one of property names matches. Case is ignored. Return value is an index of property name that matched, otherwise -1.

Parameters:

propnames - A reference to a com.esri.arcgis.system.IStringArray (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

skipUntilObjectEnds

void skipUntilObjectEnds()
                  throws java.io.IOException,
                         AutomationException

Skips the rest of the current object, including closing bracket.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

skipUntilArrayEnds

void skipUntilArrayEnds()
                 throws java.io.IOException,
                        AutomationException

Skips the rest of the current object, including closing bracket.

Throws:

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

AutomationException - If the ArcObject component throws an exception.