com.esri.arcgis.system
Class XMLStream

java.lang.Object
  extended by com.esri.arcgis.system.XMLStream
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISequentialStream, IStream, IXMLStream, java.io.Serializable

public class XMLStream
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IXMLStream, IStream

COM Class 'XMLStream'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description 'An in-memory XML stream.' 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.IXMLStream
IID, IID498a5f91_65d1_4a25_ad2b_462e7df8b358, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IStream
IID, IID0000000c_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISequentialStream
IID0c733a30_2a1c_11ce_ade5_00aa0044773d
 
Constructor Summary
XMLStream()
          Constructs a XMLStream using ArcGIS Engine.
XMLStream(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
XMLStream theXMLStream = (XMLStream) obj;
 
Method Summary
 void commit(int grfCommitFlags)
          commit
 boolean equals(java.lang.Object o)
          Compare this object with another
 void esri_clone(IStream[] ppstm)
          esri_clone
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int hashCode()
          the hashcode for this object
 void loadFromBytes(byte[] bytes)
          Loads from a UTF-8 byte array.
 void loadFromFile(java.lang.String filePath)
          Loads from a file path.
 void loadFromString(java.lang.String xML)
          Loads from a string.
 void lockRegion(_ULARGE_INTEGER libOffset, _ULARGE_INTEGER cb, int dwLockType)
          lockRegion
 void release()
          Release a XMLStream.
 void remoteCopyTo(IStream pstm, _ULARGE_INTEGER cb, _ULARGE_INTEGER[] pcbRead, _ULARGE_INTEGER[] pcbWritten)
          remoteCopyTo
 void remoteRead(byte[] pv, int cb, int[] pcbRead)
          remoteRead
 void remoteSeek(_LARGE_INTEGER dlibMove, int dwOrigin, _ULARGE_INTEGER[] plibNewPosition)
          remoteSeek
 void remoteWrite(byte[] pv, int cb, int[] pcbWritten)
          remoteWrite
 void reset()
          Resets the stream to the beginning.
 void revert()
          revert
 byte[] saveToBytes()
          Saves to a UTF-8 byte array.
 void saveToFile(java.lang.String filePath)
          Saves to a file path.
 java.lang.String saveToString()
          Saves to a string.
 void setSize(_ULARGE_INTEGER libNewSize)
          setSize
 void stat(tagSTATSTG[] pstatstg, int grfStatFlag)
          stat
 void unlockRegion(_ULARGE_INTEGER libOffset, _ULARGE_INTEGER cb, int dwLockType)
          unlockRegion
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLStream

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

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

XMLStream

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

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

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

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

loadFromString

public void loadFromString(java.lang.String xML)
                    throws java.io.IOException,
                           AutomationException
Loads from a string.

Specified by:
loadFromString in interface IXMLStream
Parameters:
xML - The xML (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadFromFile

public void loadFromFile(java.lang.String filePath)
                  throws java.io.IOException,
                         AutomationException
Loads from a file path.

Specified by:
loadFromFile in interface IXMLStream
Parameters:
filePath - The filePath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadFromBytes

public void loadFromBytes(byte[] bytes)
                   throws java.io.IOException,
                          AutomationException
Loads from a UTF-8 byte array.

Specified by:
loadFromBytes in interface IXMLStream
Parameters:
bytes - An unsigned byte (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveToString

public java.lang.String saveToString()
                              throws java.io.IOException,
                                     AutomationException
Saves to a string.

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

saveToFile

public void saveToFile(java.lang.String filePath)
                throws java.io.IOException,
                       AutomationException
Saves to a file path.

Specified by:
saveToFile in interface IXMLStream
Parameters:
filePath - The filePath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveToBytes

public byte[] saveToBytes()
                   throws java.io.IOException,
                          AutomationException
Saves to a UTF-8 byte array.

Specified by:
saveToBytes in interface IXMLStream
Returns:
An unsigned byte
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException
Resets the stream to the beginning.

Specified by:
reset in interface IXMLStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remoteSeek

public void remoteSeek(_LARGE_INTEGER dlibMove,
                       int dwOrigin,
                       _ULARGE_INTEGER[] plibNewPosition)
                throws java.io.IOException,
                       AutomationException
remoteSeek

Specified by:
remoteSeek in interface IStream
Parameters:
dlibMove - A Structure: com.esri.arcgis.system._LARGE_INTEGER (in)
dwOrigin - The dwOrigin (in)
plibNewPosition - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(_ULARGE_INTEGER libNewSize)
             throws java.io.IOException,
                    AutomationException
setSize

Specified by:
setSize in interface IStream
Parameters:
libNewSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remoteCopyTo

public void remoteCopyTo(IStream pstm,
                         _ULARGE_INTEGER cb,
                         _ULARGE_INTEGER[] pcbRead,
                         _ULARGE_INTEGER[] pcbWritten)
                  throws java.io.IOException,
                         AutomationException
remoteCopyTo

Specified by:
remoteCopyTo in interface IStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
cb - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (in)
pcbRead - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
pcbWritten - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

commit

public void commit(int grfCommitFlags)
            throws java.io.IOException,
                   AutomationException
commit

Specified by:
commit in interface IStream
Parameters:
grfCommitFlags - The grfCommitFlags (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

revert

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

Specified by:
revert in interface IStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lockRegion

public void lockRegion(_ULARGE_INTEGER libOffset,
                       _ULARGE_INTEGER cb,
                       int dwLockType)
                throws java.io.IOException,
                       AutomationException
lockRegion

Specified by:
lockRegion in interface IStream
Parameters:
libOffset - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (in)
cb - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (in)
dwLockType - The dwLockType (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unlockRegion

public void unlockRegion(_ULARGE_INTEGER libOffset,
                         _ULARGE_INTEGER cb,
                         int dwLockType)
                  throws java.io.IOException,
                         AutomationException
unlockRegion

Specified by:
unlockRegion in interface IStream
Parameters:
libOffset - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (in)
cb - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (in)
dwLockType - The dwLockType (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stat

public void stat(tagSTATSTG[] pstatstg,
                 int grfStatFlag)
          throws java.io.IOException,
                 AutomationException
stat

Specified by:
stat in interface IStream
Parameters:
pstatstg - A Structure: com.esri.arcgis.system.tagSTATSTG (out: use single element array)
grfStatFlag - The grfStatFlag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public void esri_clone(IStream[] ppstm)
                throws java.io.IOException,
                       AutomationException
esri_clone

Specified by:
esri_clone in interface IStream
Parameters:
ppstm - A reference to a com.esri.arcgis.system.IStream (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remoteRead

public void remoteRead(byte[] pv,
                       int cb,
                       int[] pcbRead)
                throws java.io.IOException,
                       AutomationException
remoteRead

Specified by:
remoteRead in interface ISequentialStream
Parameters:
pv - An unsigned byte (out: use single element array)
cb - The cb (in)
pcbRead - The pcbRead (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remoteWrite

public void remoteWrite(byte[] pv,
                        int cb,
                        int[] pcbWritten)
                 throws java.io.IOException,
                        AutomationException
remoteWrite

Specified by:
remoteWrite in interface ISequentialStream
Parameters:
pv - An unsigned byte (in)
cb - The cb (in)
pcbWritten - The pcbWritten (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.