com.esri.arcgis.system

Class ObjectStream

java.lang.Object

com.esri.arcgis.system.ObjectStream

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, IObjectStream, ISequentialStream, IStream, java.io.Serializable

public class ObjectStream
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IObjectStream, IDocumentVersion

COM Class 'ObjectStream'. Generated 5/5/2025 2:28:32 PM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'Specialized kind of IStream for objects.' 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.IObjectStream

IID, IID18a45ba7_1266_11d1_86ad_0000f8751720, xxDummy

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

IID0000000c_0000_0000_c000_000000000046

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

IID0c733a30_2a1c_11ce_ade5_00aa0044773d

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

IID, IIDecc43c55_0148_4ec1_bf87_b9a183c5dc98, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
int	getDocumentVersion() The version of the document to save.
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() The aggregated stream object.
java.lang.String	getVersion() The software version for the stream.
int	hashCode() the hashcode for this object
java.lang.Object	loadObject(GUID riid, java.lang.Object pUnkOuter) Load an object from the specified stream.
void	lockRegion(_ULARGE_INTEGER libOffset, _ULARGE_INTEGER cb, int dwLockType) lockRegion
void	release() Release this COM object reference
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	replaceObject(java.lang.Object unknown) Replaces the current object with the object in the the specified stream.
void	revert() revert
void	saveObject(java.lang.Object pUnk) Store an object to the specified stream.
void	setDocumentVersion(int docVersion) The version of the document to save.
void	setSize(_ULARGE_INTEGER libNewSize) setSize
void	setStreamByRef(IStream ppStream) The aggregated stream object.
void	setVersion(java.lang.String versionSpecifier) The software version for the stream.
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

ObjectStream

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

Constructs a ObjectStream using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ObjectStream

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

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

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

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

setStreamByRef

public void setStreamByRef(IStream ppStream)
                    throws java.io.IOException,
                           AutomationException

The aggregated stream object.

Specified by:

setStreamByRef in interface IObjectStream

Parameters:

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

getStream

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

The aggregated stream object.

Specified by:

getStream in interface IObjectStream

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.

saveObject

public void saveObject(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

Store an object to the specified stream. The first time the object is stored, the full object is written to the stream. When the object is subsequently stored, a reference is stored.

Specified by:

saveObject in interface IObjectStream

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadObject

public java.lang.Object loadObject(GUID riid,
                                   java.lang.Object pUnkOuter)
                            throws java.io.IOException,
                                   AutomationException

Load an object from the specified stream. The first time an object is encountered, it is loaded from the stream. When subsequent references to the object are loaded, a pointer to the first object is returned.

Specified by:

loadObject in interface IObjectStream

Parameters:

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

pUnkOuter - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replaceObject

public void replaceObject(java.lang.Object unknown)
                   throws java.io.IOException,
                          AutomationException

Replaces the current object with the object in the the specified stream.

Specified by:

replaceObject in interface IObjectStream

Parameters:

unknown - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVersion

public void setVersion(java.lang.String versionSpecifier)
                throws java.io.IOException,
                       AutomationException

The software version for the stream.

Specified by:

setVersion in interface IObjectStream

Parameters:

versionSpecifier - The versionSpecifier (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersion

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

The software version for the stream.

Specified by:

getVersion in interface IObjectStream

Returns:

The versionSpecifier

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.

setDocumentVersion

public void setDocumentVersion(int docVersion)
                        throws java.io.IOException,
                               AutomationException

The version of the document to save.

Specified by:

setDocumentVersion in interface IDocumentVersion

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws java.io.IOException,
                              AutomationException

The version of the document to save.

Specified by:

getDocumentVersion in interface IDocumentVersion

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.