DOMConvertor (Settings API)

java.lang.Object
- org.netbeans.spi.settings.Convertor
- - org.netbeans.spi.settings.DOMConvertor

```
public abstract class DOMConvertor
extends Convertor
```
DOMConvertor extends the Convertor to allow to compose output of several convertors into one xml document. For more info see Composed Content.

Since:

1.1

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`DOMConvertor(java.lang.String publicID, java.lang.String systemID, java.lang.String rootElement)`	Creat a DOMConvertor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected static java.lang.Object`	`delegateRead(org.w3c.dom.Element element)`	delegate the read operation to a convertor referenced by `dtd_public_id`
`protected static org.w3c.dom.Element`	`delegateWrite(org.w3c.dom.Document doc, java.lang.Object obj)`	delegate the write operation to a convertor able to write `obj.`
`protected static org.openide.util.Lookup`	`findContext(org.w3c.dom.Document doc)`	get a context associated with the document `doc`.
`java.lang.Object`	`read(java.io.Reader r)`	Read content from `r` and delegate to `readElement(org.w3c.dom.Element)` passing parsed content as a root element of DOM document
`protected abstract java.lang.Object`	`readElement(org.w3c.dom.Element element)`	Provide an object constructed from the element.
`void`	`write(java.io.Writer w, java.lang.Object inst)`	Write object described by DOM document filled by `writeElement(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.Object)`
`protected abstract void`	`writeElement(org.w3c.dom.Document doc, org.w3c.dom.Element element, java.lang.Object obj)`	Fill a DOM element describing `obj` with attributes or subelements.

Methods inherited from class org.netbeans.spi.settings.Convertor
findContext, findContext, registerSaver, unregisterSaver

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DOMConvertor
```
protected DOMConvertor(java.lang.String publicID,
                       java.lang.String systemID,
                       java.lang.String rootElement)
```
    Creat a DOMConvertor
    
    Parameters:
    
    publicID - public ID of DOCTYPE
    
    systemID - system ID of DOCTYPE
    
    rootElement - qualified name of root element
- Method Detail
  - read
```
public final java.lang.Object read(java.io.Reader r)
                            throws java.io.IOException,
                                   java.lang.ClassNotFoundException
```
    Read content from r and delegate to readElement(org.w3c.dom.Element) passing parsed content as a root element of DOM document
    
    Specified by:
    
    read in class Convertor
    
    Parameters:
    
    r - stream containing stored object
    
    Returns:
    
    the read setting object
    
    Throws:
    
    java.io.IOException - if the object cannot be read
    
    java.lang.ClassNotFoundException - if the object class cannot be resolved
    
    Since:
    
    1.1
  - write
```
public final void write(java.io.Writer w,
                        java.lang.Object inst)
                 throws java.io.IOException
```
    Write object described by DOM document filled by writeElement(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.Object)
    
    Specified by:
    
    write in class Convertor
    
    Parameters:
    
    w - stream into which inst is written
    
    inst - the setting object to be written
    
    Throws:
    
    java.io.IOException - if the object cannot be written
    
    Since:
    
    1.1
  - readElement
```
protected abstract java.lang.Object readElement(org.w3c.dom.Element element)
                                         throws java.io.IOException,
                                                java.lang.ClassNotFoundException
```
    Provide an object constructed from the element.
    
    Parameters:
    
    element - represents a read object in a DOM document
    
    Returns:
    
    an setting object
    
    Throws:
    
    java.io.IOException - if the object cannot be read
    
    java.lang.ClassNotFoundException - if the object class cannot be resolved
    
    Since:
    
    1.1
  - writeElement
```
protected abstract void writeElement(org.w3c.dom.Document doc,
                                     org.w3c.dom.Element element,
                                     java.lang.Object obj)
                              throws java.io.IOException,
                                     org.w3c.dom.DOMException
```
    Fill a DOM element describing obj with attributes or subelements.
    
    Parameters:
    
    doc - a DOM document allowing to create elements describing passed object
    
    element - represents a written object in a DOM document
    
    obj - an object to convert
    
    Throws:
    
    java.io.IOException - if the object cannot be written
    
    org.w3c.dom.DOMException - if an element construction failed
    
    Since:
    
    1.1
  - delegateRead
```
protected static final java.lang.Object delegateRead(org.w3c.dom.Element element)
                                              throws java.io.IOException,
                                                     java.lang.ClassNotFoundException
```
    delegate the read operation to a convertor referenced by dtd_public_id
    
    Parameters:
    
    element - DOM element that should be read
    
    Returns:
    
    an setting object
    
    Throws:
    
    java.io.IOException - if the object cannot be read
    
    java.lang.ClassNotFoundException - if the object class cannot be resolved
    
    Since:
    
    1.1
    
    See Also:
    
    readElement(org.w3c.dom.Element)
  - delegateWrite
```
protected static final org.w3c.dom.Element delegateWrite(org.w3c.dom.Document doc,
                                                         java.lang.Object obj)
                                                  throws java.io.IOException,
                                                         org.w3c.dom.DOMException
```
    delegate the write operation to a convertor able to write obj.
    Parameters: doc - a DOM document allowing to create elements describing passed object obj - an object to convert Returns: a DOM element representation Throws: java.io.IOException - if the object cannot be written org.w3c.dom.DOMException - if an element construction failed Since: 1.1 See Also: writeElement(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.Object)
  findContext protected static org.openide.util.Lookup findContext(org.w3c.dom.Document doc) get a context associated with the document doc. It can contain various info like a file location of the read document etc. Parameters: doc - a DOM document containing stored object Returns: a context associated with the document Since: 1.2

Class DOMConvertor

Constructor Summary

Method Summary

Methods inherited from class org.netbeans.spi.settings.Convertor

Methods inherited from class java.lang.Object

Constructor Detail

DOMConvertor

Method Detail

read

write

readElement

writeElement

delegateRead

delegateWrite

findContext