com.esri.arcgis.system

Class FileStream

java.lang.Object

com.esri.arcgis.system.FileStream

All Implemented Interfaces:

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

public class FileStream
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBlobStream, IFile, IDocumentVersion

COM Class 'FileStream'. Generated 9/24/2024 11:01:25 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

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

IID, IIDbc92995e_e736_11d0_9a93_080009ec734b, 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.IFile

IID, IID381d1aa2_c06f_11d2_9f82_00c04f8ed211, xxDummy

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

IID, IIDecc43c55_0148_4ec1_bf87_b9a183c5dc98, xxDummy

Constructor Summary

Constructors

Constructor and Description
FileStream() Constructs a FileStream using ArcGIS Engine.
FileStream(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FileStream theFileStream = (FileStream) 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.
int	getSize() The size of the stream.
int	hashCode() the hashcode for this object
void	loadFromFile(java.lang.String fileName) Loads a stream from the specified file.
void	lockRegion(_ULARGE_INTEGER libOffset, _ULARGE_INTEGER cb, int dwLockType) lockRegion
void	open(java.lang.String fileName, int permission) Opens the specified file.
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	revert() revert
void	saveToFile(java.lang.String fileName) Saves the stream to the specified file.
void	setDocumentVersion(int docVersion) The version of the document to save.
void	setSize(_ULARGE_INTEGER libNewSize) setSize
void	setSize(int size) The size of 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

FileStream

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

Constructs a FileStream using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FileStream

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

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

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

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

getSize

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

The size of the stream.

Specified by:

getSize in interface IBlobStream

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(int size)
             throws java.io.IOException,
                    AutomationException

The size of the stream.

Specified by:

setSize in interface IBlobStream

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveToFile

public void saveToFile(java.lang.String fileName)
                throws java.io.IOException,
                       AutomationException

Saves the stream to the specified file.

Specified by:

saveToFile in interface IBlobStream

Parameters:

fileName - The fileName (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 fileName)
                  throws java.io.IOException,
                         AutomationException

Loads a stream from the specified file.

Specified by:

loadFromFile in interface IBlobStream

Parameters:

fileName - The fileName (in)

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.

open

public void open(java.lang.String fileName,
                 int permission)
          throws java.io.IOException,
                 AutomationException

Opens the specified file.

Specified by:

open in interface IFile

Parameters:

fileName - The fileName (in)

permission - A com.esri.arcgis.system.esriFilePermission constant (in)

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.