javax.ide.model.xml
Class XMLDocument

java.lang.Object
  javax.ide.model.Element
      javax.ide.model.Document
          javax.ide.model.text.TextDocument
              javax.ide.model.xml.XMLDocument

public class XMLDocument
extends TextDocument

The XMLDocument class.

Constructor Summary

XMLDocument()

Method Summary

XMLModel

getXMLModel(Project project) Fetches the XMLModel.

Methods inherited from class javax.ide.model.text.TextDocument

getTextModel

Methods inherited from class javax.ide.model.Document

addDocumentListener, close, equals, getDisplayInfo, getElementImpl, getReader, getTimestamp, getURI, hashCode, isDirty, isNew, isOpen, isReadOnly, markDirty, open, removeDocumentListener, save, setDisplayInfo, setURI

Methods inherited from class javax.ide.model.Element

getIcon, getLabel, getLongLabel, getToolTip

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDocument

public XMLDocument()

Method Detail

getXMLModel

public final XMLModel getXMLModel(Project project)
                           throws java.io.IOException

Fetches the XMLModel. This calls opens the document and loads its contents. The XMLModel instance returned lives while clients refer to it. Once a model instance is not referred by clients it may be garbage collected at any time.

Returns:

the XMLModel containing the document's xml model.

Throws:

java.io.IOException - if the document cannot be opened.