com.esri.arcgis.system
Interface IXMLStream

All Superinterfaces:

Serializable

All Known Implementing Classes:

XMLStream

public interface IXMLStream
extends Serializable

Provides access to members that control an in-memory XML stream.

Remarks

The IXmlStream interface provides seven methods to use for serialization. The LoadFromString method loads data saved as a string from memory while LoadFromFile method loads data saved as a file e.g. file path\foo.xml. The LoadFromBytes method loads data saved as from a UTF-8 byte array, while SaveToString method saves object as a string to memory. The SaveToFile method saves object stream as a file e.g. foo.xml. The SaveToBytes saves object stream as UTF-8 byte array, while Reset method resets the stream to the beginning.

Product Availability

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

Method Summary

void	loadFromBytes(byte[] bytes) Loads from a UTF-8 byte array.
void	loadFromFile(String filePath) Loads from a file path.
void	loadFromString(String xML) Loads from a string.
void	reset() Resets the stream to the beginning.
byte[]	saveToBytes() Saves to a UTF-8 byte array.
void	saveToFile(String filePath) Saves to a file path.
String	saveToString() Saves to a string.

Method Detail

loadFromString

void loadFromString(String xML)
                    throws IOException,
                           AutomationException

Loads from a string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

xML - The xML (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromFile

void loadFromFile(String filePath)
                  throws IOException,
                         AutomationException

Loads from a file path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromBytes

void loadFromBytes(byte[] bytes)
                   throws IOException,
                          AutomationException

Loads from a UTF-8 byte array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bytes - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToString

String saveToString()
                    throws IOException,
                           AutomationException

Saves to a string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The xML

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToFile

void saveToFile(String filePath)
                throws IOException,
                       AutomationException

Saves to a file path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToBytes

byte[] saveToBytes()
                   throws IOException,
                          AutomationException

Saves to a UTF-8 byte array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the stream to the beginning.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.