com.esri.arcgis.system

Interface IJSONWriter

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IJSONWriter2, IJSONWriter3, IJSONWriter4

All Known Implementing Classes:

IJSONWriter2Proxy, IJSONWriter3Proxy, IJSONWriter4Proxy, IJSONWriterProxy, JSONWriter

public interface IJSONWriter
extends java.io.Serializable

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

Description: 'Provides access to members that control the sequential writing of JSON.' 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	IID408cd30c_b7a6_4793_a07c_4181035c66e7
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	endArray() Ends an array.
void	endObject() Ends writing of an object.
IStream	getStream() Obtains underlying stream.
byte[]	getStringBuffer() Obtains copy of string buffer.
void	setFormatted(boolean value) Writes 'pretty' formatting on or off.
void	setIndent(int value) Writes indent for 'pretty' formatting.
void	startArray(java.lang.String name) Starts an array.
void	startObject(java.lang.String name) Starts writing an object.
void	writeBinary(java.lang.String name, byte[] value) Writes a byte array.
void	writeBinaryVal(byte[] value) Writes a byte array.
void	writeBoolean(java.lang.String name, boolean value) Writes a boolean.
void	writeBooleanVal(boolean value) Writes a boolean in array.
void	writeByte(java.lang.String name, byte value) Writes a byte.
void	writeByteVal(byte value) Writes a byte in array.
void	writeDate(java.lang.String name, java.util.Date value, boolean asString) Writes a date.
void	writeDateVal(java.util.Date value, boolean asString) Writes a date in array.
void	writeDouble(java.lang.String name, double value) Writes a double.
void	writeDoubleVal(double value) Writes a double in array.
void	writeFloat(java.lang.String name, float value) Writes a float.
void	writeFloatVal(float value) Writes a float in array.
void	writeInteger(java.lang.String name, int value) Writes an integer.
void	writeIntegerVal(int value) Writes an integer in array.
void	writeNull(java.lang.String name) Writes null property.
void	writeNullVal() Writes null value in array.
void	writeShort(java.lang.String name, short value) Writes a short.
void	writeShortVal(short value) Writes a short int in array.
void	writeString(java.lang.String name, java.lang.String value) Writes a string property.
void	writeStringVal(java.lang.String value) Writes a string in array.
void	writeTo(IStream outputStream) Specifies output JSON stream.
void	writeToString() Redirects writing to internal string buffer.
void	writeVariant(java.lang.String name, java.lang.Object value) Writes a variant valued property.
void	writeVariantVal(java.lang.Object value) Writes a variant in array.

Field Detail

IID408cd30c_b7a6_4793_a07c_4181035c66e7

static final int IID408cd30c_b7a6_4793_a07c_4181035c66e7

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

writeTo

void writeTo(IStream outputStream)
      throws java.io.IOException,
             AutomationException

Specifies output JSON stream.

Parameters:

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

writeToString

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

Redirects writing to internal string buffer.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStringBuffer

byte[] getStringBuffer()
                throws java.io.IOException,
                       AutomationException

Obtains copy of string buffer. Encoding is UTF8.

Returns:

An unsigned byte

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. If WriteTo() is not called yet, will return NULL. Also will return NULL if WriteToString() was called.

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.

setFormatted

void setFormatted(boolean value)
           throws java.io.IOException,
                  AutomationException

Writes 'pretty' formatting on or off.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIndent

void setIndent(int value)
        throws java.io.IOException,
               AutomationException

Writes indent for 'pretty' formatting. Default is 2.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startObject

void startObject(java.lang.String name)
          throws java.io.IOException,
                 AutomationException

Starts writing an object.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endObject

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

Ends writing of an object.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startArray

void startArray(java.lang.String name)
         throws java.io.IOException,
                AutomationException

Starts an array.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

endArray

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

Ends an array.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeVariant

void writeVariant(java.lang.String name,
                  java.lang.Object value)
           throws java.io.IOException,
                  AutomationException

Writes a variant valued property.

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeString

void writeString(java.lang.String name,
                 java.lang.String value)
          throws java.io.IOException,
                 AutomationException

Writes a string property.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBoolean

void writeBoolean(java.lang.String name,
                  boolean value)
           throws java.io.IOException,
                  AutomationException

Writes a boolean.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeByte

void writeByte(java.lang.String name,
               byte value)
        throws java.io.IOException,
               AutomationException

Writes a byte.

Parameters:

name - The name (in)

value - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeShort

void writeShort(java.lang.String name,
                short value)
         throws java.io.IOException,
                AutomationException

Writes a short.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeInteger

void writeInteger(java.lang.String name,
                  int value)
           throws java.io.IOException,
                  AutomationException

Writes an integer.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeFloat

void writeFloat(java.lang.String name,
                float value)
         throws java.io.IOException,
                AutomationException

Writes a float.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeDouble

void writeDouble(java.lang.String name,
                 double value)
          throws java.io.IOException,
                 AutomationException

Writes a double.

Parameters:

name - The name (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeDate

void writeDate(java.lang.String name,
               java.util.Date value,
               boolean asString)
        throws java.io.IOException,
               AutomationException

Writes a date.

Parameters:

name - The name (in)

value - The value (in)

asString - The asString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBinary

void writeBinary(java.lang.String name,
                 byte[] value)
          throws java.io.IOException,
                 AutomationException

Writes a byte array.

Parameters:

name - The name (in)

value - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeNull

void writeNull(java.lang.String name)
        throws java.io.IOException,
               AutomationException

Writes null property.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeVariantVal

void writeVariantVal(java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Writes a variant in array.

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeStringVal

void writeStringVal(java.lang.String value)
             throws java.io.IOException,
                    AutomationException

Writes a string in array.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBooleanVal

void writeBooleanVal(boolean value)
              throws java.io.IOException,
                     AutomationException

Writes a boolean in array.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeByteVal

void writeByteVal(byte value)
           throws java.io.IOException,
                  AutomationException

Writes a byte in array.

Parameters:

value - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeShortVal

void writeShortVal(short value)
            throws java.io.IOException,
                   AutomationException

Writes a short int in array.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeIntegerVal

void writeIntegerVal(int value)
              throws java.io.IOException,
                     AutomationException

Writes an integer in array.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeFloatVal

void writeFloatVal(float value)
            throws java.io.IOException,
                   AutomationException

Writes a float in array.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeDoubleVal

void writeDoubleVal(double value)
             throws java.io.IOException,
                    AutomationException

Writes a double in array.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeDateVal

void writeDateVal(java.util.Date value,
                  boolean asString)
           throws java.io.IOException,
                  AutomationException

Writes a date in array.

Parameters:

value - The value (in)

asString - The asString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBinaryVal

void writeBinaryVal(byte[] value)
             throws java.io.IOException,
                    AutomationException

Writes a byte array.

Parameters:

value - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeNullVal

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

Writes null value in array.

Throws:

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

AutomationException - If the ArcObject component throws an exception.