com.esri.arcgis.system

Class XMLWriter

java.lang.Object

com.esri.arcgis.system.XMLWriter

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IXMLWriter, IXMLWriter2, java.io.Serializable

public class XMLWriter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IXMLWriter, IXMLWriter2, ISupportErrorInfo

COM Class 'XMLWriter'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'An XML sequential document writer.' 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.system.IXMLWriter2

IID, IID034900a2_4db4_4074_8a7b_3a0885b844a2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLWriter

IID5f50e520_1278_4c7a_937c_ae5874548431

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

Constructors

Constructor and Description
XMLWriter() Constructs a XMLWriter using ArcGIS Engine.
XMLWriter(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. XMLWriter theXMLWriter = (XMLWriter) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IStream	getStream() Obtains underlying stream.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
java.lang.String	lookupNamespace(java.lang.String uri) Obtains the declared namespace prefix for a namespace.
void	release() Release this COM object reference
void	writeBinary(byte[] value) Writes an element value as a binary array.
void	writeBoolean(boolean value) Writes an element value as a boolean.
void	writeByte(byte value) Writes an element value as a byte.
void	writeCData(java.lang.String cdata) Writes a CDATA section.
void	writeDate(java.util.Date value) Writes an element value as a date.
void	writeDouble(double value) Writes an element value as a double.
void	writeEndTag() Writes the ending tag of an element.
void	writeFloat(float value) Writes an element value as a float.
void	writeInt64(long value) Writes an element value as an int64.
void	writeInteger(int value) Writes an element value as a long.
void	writeNewLine() Writes a newline.
void	writeShort(short value) Writes an element value as a short.
void	writeStartTag(java.lang.String localName, java.lang.String uri, IXMLAttributes attributes, IXMLNamespaces namespaces, boolean isEmpty) Writes the starting tag of an element.
void	writeTab() Writes a tab.
void	writeText(java.lang.String text) Writes the text value of an element.
void	writeTo(IStream outputStream) Specifies output XML stream.
void	writeVariant(java.lang.Object value) Writes an element value as a variant.
void	writeXML(java.lang.String xML) Writes raw XML.
void	writeXMLDeclaration() Writes the XML document declaration.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLWriter

public XMLWriter()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a XMLWriter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

XMLWriter

public XMLWriter(java.lang.Object obj)
          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
XMLWriter theXMLWriter = (XMLWriter) obj;

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

writeTo

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

Specifies output XML stream.

Specified by:

writeTo in interface IXMLWriter

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.

writeStartTag

public void writeStartTag(java.lang.String localName,
                          java.lang.String uri,
                          IXMLAttributes attributes,
                          IXMLNamespaces namespaces,
                          boolean isEmpty)
                   throws java.io.IOException,
                          AutomationException

Writes the starting tag of an element.

Specified by:

writeStartTag in interface IXMLWriter

Parameters:

localName - The localName (in)

uri - The uri (in)

attributes - A reference to a com.esri.arcgis.system.IXMLAttributes (in)

namespaces - A reference to a com.esri.arcgis.system.IXMLNamespaces (in)

isEmpty - The isEmpty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeText

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

Writes the text value of an element.

Specified by:

writeText in interface IXMLWriter

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeCData

public void writeCData(java.lang.String cdata)
                throws java.io.IOException,
                       AutomationException

Writes a CDATA section.

Specified by:

writeCData in interface IXMLWriter

Parameters:

cdata - The cdata (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeEndTag

public void writeEndTag()
                 throws java.io.IOException,
                        AutomationException

Writes the ending tag of an element.

Specified by:

writeEndTag in interface IXMLWriter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBoolean

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

Writes an element value as a boolean.

Specified by:

writeBoolean in interface IXMLWriter

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeByte

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

Writes an element value as a byte.

Specified by:

writeByte in interface IXMLWriter

Parameters:

value - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeShort

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

Writes an element value as a short.

Specified by:

writeShort in interface IXMLWriter

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeInteger

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

Writes an element value as a long.

Specified by:

writeInteger in interface IXMLWriter

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeFloat

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

Writes an element value as a float.

Specified by:

writeFloat in interface IXMLWriter

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeDouble

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

Writes an element value as a double.

Specified by:

writeDouble in interface IXMLWriter

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeDate

public void writeDate(java.util.Date value)
               throws java.io.IOException,
                      AutomationException

Writes an element value as a date.

Specified by:

writeDate in interface IXMLWriter

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeBinary

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

Writes an element value as a binary array.

Specified by:

writeBinary in interface IXMLWriter

Parameters:

value - An unsigned byte (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeVariant

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

Writes an element value as a variant.

Specified by:

writeVariant in interface IXMLWriter

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeXML

public void writeXML(java.lang.String xML)
              throws java.io.IOException,
                     AutomationException

Writes raw XML.

Specified by:

writeXML in interface IXMLWriter

Parameters:

xML - The xML (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeXMLDeclaration

public void writeXMLDeclaration()
                         throws java.io.IOException,
                                AutomationException

Writes the XML document declaration.

Specified by:

writeXMLDeclaration in interface IXMLWriter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeNewLine

public void writeNewLine()
                  throws java.io.IOException,
                         AutomationException

Writes a newline.

Specified by:

writeNewLine in interface IXMLWriter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeTab

public void writeTab()
              throws java.io.IOException,
                     AutomationException

Writes a tab.

Specified by:

writeTab in interface IXMLWriter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lookupNamespace

public java.lang.String lookupNamespace(java.lang.String uri)
                                 throws java.io.IOException,
                                        AutomationException

Obtains the declared namespace prefix for a namespace.

Specified by:

lookupNamespace in interface IXMLWriter

Parameters:

uri - The uri (in)

Returns:

The prefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStream

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

Obtains underlying stream. If WriteTo() is not called yet, will return NULL.

Specified by:

getStream in interface IXMLWriter2

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.

writeInt64

public void writeInt64(long value)
                throws java.io.IOException,
                       AutomationException

Writes an element value as an int64.

Specified by:

writeInt64 in interface IXMLWriter2

Parameters:

value - Signed 64-bit int (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.