com.esri.arcgis.system
Class VariantStreamIO

java.lang.Object
  com.esri.arcgis.system.VariantStreamIO

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, IVariantStream, IVariantStreamIO, Serializable

public class VariantStreamIO
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IVariantStreamIO, IVariantStream, IDocumentVersion

Helper object that performs stream IO for Variants.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

VariantStreamIO()
Constructs a VariantStreamIO using ArcGIS Engine.

VariantStreamIO(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
VariantStreamIO theVariantStreamIO = (VariantStreamIO) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getDocumentVersion() The version of the document to save.
int	hashCode() the hashcode for this object
Object	read() Reads a value from a stream.
void	setDocumentVersion(int docVersion) The version of the document to save.
void	setStreamByRef(IStream rhs1) The stream to perform variant stream reads and writes to.
void	write(Object value) Writes a value to a stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

VariantStreamIO

public VariantStreamIO()
                throws IOException,
                       UnknownHostException

Constructs a VariantStreamIO using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

VariantStreamIO

public VariantStreamIO(Object obj)
                throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setStreamByRef

public void setStreamByRef(IStream rhs1)
                    throws IOException,
                           AutomationException

The stream to perform variant stream reads and writes to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStreamByRef in interface IVariantStreamIO

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

read

public Object read()
            throws IOException,
                   AutomationException

Reads a value from a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

read in interface IVariantStream

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

write

public void write(Object value)
           throws IOException,
                  AutomationException

Writes a value to a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

write in interface IVariantStream

Parameters:

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDocumentVersion

public void setDocumentVersion(int docVersion)
                        throws IOException,
                               AutomationException

The version of the document to save.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDocumentVersion in interface IDocumentVersion

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws IOException,
                              AutomationException

The version of the document to save.

Remarks

Determines which version an object is persisted. This can be useful when saving an object ObjectStream or MemoryBlobStream and you want the version of that object to be compatible with previous releases of ArcGIS. Not all persistable objects implement IDocumentVersion; you should ensure the object supports this interface before accessing this property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getDocumentVersion in interface IDocumentVersion

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.