com.esri.arcgis.system
Class XMLFlags

java.lang.Object
  extended by com.esri.arcgis.system.XMLFlags
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IXMLFlags, Serializable

public class XMLFlags
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IXMLFlags

A collection of XML flags.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
XMLFlags()
          Constructs a XMLFlags using ArcGIS Engine.
XMLFlags(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
XMLFlags theXMLFlags = (XMLFlags) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getCount()
          Number of flags.
 boolean getFlag(String name)
          Indicates whether XML flag is set.
 String getFlagName(int index)
          Flag name by index.
 int hashCode()
          the hashcode for this object
 boolean isFlagValue(int index)
          Indicates whether the flag has value by index.
 void setFlag(String name, boolean flagValue)
          Sets a flag value.
 
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

XMLFlags

public XMLFlags()
         throws IOException,
                UnknownHostException
Constructs a XMLFlags using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

XMLFlags

public XMLFlags(Object obj)
         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
XMLFlags theXMLFlags = (XMLFlags) obj;

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

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

setFlag

public void setFlag(String name,
                    boolean flagValue)
             throws IOException,
                    AutomationException
Sets a flag value.

Product Availability

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

Specified by:
setFlag in interface IXMLFlags
Parameters:
name - The name (in)
flagValue - The flagValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlag

public boolean getFlag(String name)
                throws IOException,
                       AutomationException
Indicates whether XML flag is set.

Product Availability

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

Specified by:
getFlag in interface IXMLFlags
Parameters:
name - The name (in)
Returns:
The flagValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
Number of flags.

Product Availability

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

Specified by:
getCount in interface IXMLFlags
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlagName

public String getFlagName(int index)
                   throws IOException,
                          AutomationException
Flag name by index.

Product Availability

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

Specified by:
getFlagName in interface IXMLFlags
Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFlagValue

public boolean isFlagValue(int index)
                    throws IOException,
                           AutomationException
Indicates whether the flag has value by index.

Product Availability

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

Specified by:
isFlagValue in interface IXMLFlags
Parameters:
index - The index (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.