SaveDocument (XMLmind XML Editor Java[tm] API)

java.lang.Object
- com.xmlmind.xml.save.SaveDocument

```
public final class SaveDocument
extends Object
```
High-level document writing facility.

See Also:

DocumentWriter, DocumentIndenter

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentIndenter`	`createDocumentIndenter(Writer out)` Not part of the public, documented, API: creates and returns a possibly custom `DocumentIndenter`.
`static DocumentWriter`	`createDocumentWriter(Writer out)` Not part of the public, documented, API: creates and returns a possibly custom `DocumentWriter`.
`static DocumentWriter`	`createDocumentWriter(Writer out, String encoding, SaveOptions options, Document document)` Creates a properly configured document writer.
`static String`	`getDocumentIndenterClassName()` Not part of the public, documented, API: returns the class name of a custom `DocumentIndenter`.
`static String`	`getDocumentWriterClassName()` Not part of the public, documented, API: returns the class name of a custom `DocumentWriter`.
`static boolean`	`prepareSaveAs(Document document, URL saveURL)` Modifies the document to be saved prior to a ``save as'' operation.
`static void`	`prepareSaveAs2(Document document, ResourceSelector[] resourceSpecs, URL docURL, URL saveURL, boolean[] modified)` Not part of the public documented API: update references to resources in the document to be saved prior to a ``save as'' operation.
`static void`	`save(Document document, File file)` Save specified document to specified file using default `SaveOptions`.
`static void`	`save(Document document, File file, SaveOptions options)` Save specified document to specified file using specified `SaveOptions`.
`static void`	`save(Document document, OutputStream out, SaveOptions options)` Save specified document to specified output destination using specified `SaveOptions`.
`static void`	`save(Document document, Writer writer, SaveOptions options)` Similar to `save(Document, OutputStream, SaveOptions)` but using a `Writer` as the output destination.
`static void`	`save(Element element, File file)` Save specified element to specified file using default encoding.
`static void`	`save(Element element, File file, String encoding)` Save specified element to specified file using specified encoding.
`static void`	`save(Element element, OutputStream out, String encoding)` Save specified element to specified output stream using specified encoding.
`static void`	`save(Element element, Writer writer, String encoding)` Similar to `save(Element, OutputStream, String)` but using a `Writer` as the output destination.
`static void`	`saveAs(Document document, File file)` Save specified document to specified file using default `SaveOptions`.
`static void`	`setDocumentIndenterClassName(String className)` Not part of the public, documented, API: allows to specify the class name of a custom `DocumentIndenter`.
`static void`	`setDocumentWriterClassName(String className)` Not part of the public, documented, API: allows to specify the class name of a custom `DocumentWriter`.
`static String`	`toString(Element element, Element reference, int indent)` Not part of the public documented API: Similar to `toString(Element, int)`, except that this method makes a difference between the reference element, generally attached to the document tree and the element to be saved, generally a modified copy of the reference element, not attached to the document tree.
`static String`	`toString(Element element, int indent)` Returns specified element in its XML form.
`static void`	`writeXMLDeclaration(String version, String encoding, String standalone, Writer out)` Writes specified XML declaration (`<?`

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

- Method Detail
  - save
```
public static void save(Document document,
                        File file)
                 throws IOException
```
    Save specified document to specified file using default SaveOptions.
    
    Parameters:
    
    document - Document to be saved.
    
    file - The save file.
    
    Throws:
    
    IOException - if, for any reason, the document cannot be saved.
  - save
```
public static void save(Document document,
                        File file,
                        SaveOptions options)
                 throws IOException
```
    Save specified document to specified file using specified SaveOptions.
    
    Parameters:
    
    document - Document to be saved.
    
    file - The save file.
    
    options - Save options. null means defaults.
    
    Throws:
    
    IOException - if, for any reason, the document cannot be saved.
  - save
```
public static void save(Document document,
                        OutputStream out,
                        SaveOptions options)
                 throws IOException
```
    Save specified document to specified output destination using specified SaveOptions.
    
    Parameters:
    
    document - Document to be saved.
    
    out - The output destination.
    
    options - Save options. null means defaults.
    
    Throws:
    
    IOException - if, for any reason, the document cannot be saved.
  - save
```
public static void save(Document document,
                        Writer writer,
                        SaveOptions options)
                 throws IOException
```
    Similar to save(Document, OutputStream, SaveOptions) but using a Writer as the output destination.
    
    Throws:
    
    IOException
  - writeXMLDeclaration
```
public static void writeXMLDeclaration(String version,
                                       String encoding,
                                       String standalone,
                                       Writer out)
                                throws IOException
```
    Writes specified XML declaration (<?xml ... ?>) to specified output.
    
    Parameters:
    
    version - XML version: "1.0" or "1.1". May be null in which case SaveOptions.FALLBACK_VERSION is used.
    
    encoding - encoding used for the save file. May be null in which case encoding= is omitted.
    
    standalone - "yes" or "no", specifies whether the save file contains a standalone document. May be null in which case standalone= is omitted.
    
    Throws:
    
    IOException - if there is an IO problem
  - createDocumentWriter
```
public static DocumentWriter createDocumentWriter(Writer out,
                                                  String encoding,
                                                  SaveOptions options,
                                                  Document document)
                                           throws UnsupportedEncodingException
```
    Creates a properly configured document writer.
    
    Parameters:
    
    out - The output destination.
    
    encoding - The XML encoding of the save file. Overrides what's specified in options.
    
    options - Save options. null means defaults.
    
    document - Document to be saved.
    
    Throws:
    
    UnsupportedEncodingException - If encoding is not supported.
  - save
```
public static void save(Element element,
                        File file)
                 throws IOException
```
    Save specified element to specified file using default encoding.
    The save file is not indented. Inclusions possibly contained in element are not preserved.
    
    Parameters:
    
    element - the element to be saved.
    
    file - the save file.
    
    Throws:
    
    IOException - if, for any reason, the element cannot be saved.
    
    See Also:
    
    SaveOptions.FALLBACK_ENCODING
  - save
```
public static void save(Element element,
                        File file,
                        String encoding)
                 throws IOException
```
    Save specified element to specified file using specified encoding.
    The save file is not indented. Inclusions possibly contained in element are not preserved.
    
    Parameters:
    
    element - Element to be saved.
    
    file - The save file.
    
    encoding - The encoding of the save file. null means default.
    
    Throws:
    
    IOException - if, for any reason, the element cannot be saved.
    
    See Also:
    
    SaveOptions.FALLBACK_ENCODING
  - save
```
public static void save(Element element,
                        OutputStream out,
                        String encoding)
                 throws IOException
```
    Save specified element to specified output stream using specified encoding.
    The save file is not indented. Inclusions possibly contained in element are not preserved.
    
    Parameters:
    
    element - the element to be saved.
    
    out - the output destination.
    
    encoding - the encoding of the save file. null means default.
    
    Throws:
    
    IOException - if, for any reason, the element cannot be saved.
    
    See Also:
    
    SaveOptions.FALLBACK_ENCODING
  - save
```
public static void save(Element element,
                        Writer writer,
                        String encoding)
                 throws IOException
```
    Similar to save(Element, OutputStream, String) but using a Writer as the output destination.
    
    Throws:
    
    IOException
  - toString
```
public static String toString(Element element,
                              int indent)
```
    Returns specified element in its XML form. The return string is mainly useful while debugging and testing.
    
    Parameters:
    
    element - element to be formatted. This element may or may not be attached to the document tree.
    
    indent - identation; a negative number means: do not indent
    
    Returns:
    
    specified element in its XML form
  - toString
```
public static String toString(Element element,
                              Element reference,
                              int indent)
```
    Not part of the public documented API: Similar to toString(Element, int), except that this method makes a difference between the reference element, generally attached to the document tree and the element to be saved, generally a modified copy of the reference element, not attached to the document tree.
  - setDocumentWriterClassName
```
public static void setDocumentWriterClassName(String className)
```
    Not part of the public, documented, API: allows to specify the class name of a custom DocumentWriter.
    
    See Also:
    
    getDocumentWriterClassName()
  - getDocumentWriterClassName
```
public static String getDocumentWriterClassName()
```
    Not part of the public, documented, API: returns the class name of a custom DocumentWriter.
    
    See Also:
    
    setDocumentWriterClassName(java.lang.String)
  - createDocumentWriter
```
public static DocumentWriter createDocumentWriter(Writer out)
```
    Not part of the public, documented, API: creates and returns a possibly custom DocumentWriter.
    
    See Also:
    
    setDocumentWriterClassName(java.lang.String), getDocumentWriterClassName()
  - setDocumentIndenterClassName
```
public static void setDocumentIndenterClassName(String className)
```
    Not part of the public, documented, API: allows to specify the class name of a custom DocumentIndenter.
    
    See Also:
    
    getDocumentIndenterClassName()
  - getDocumentIndenterClassName
```
public static String getDocumentIndenterClassName()
```
    Not part of the public, documented, API: returns the class name of a custom DocumentIndenter.
    
    See Also:
    
    setDocumentIndenterClassName(java.lang.String)
  - createDocumentIndenter
```
public static DocumentIndenter createDocumentIndenter(Writer out)
```
    Not part of the public, documented, API: creates and returns a possibly custom DocumentIndenter.
    
    See Also:
    
    setDocumentIndenterClassName(java.lang.String), getDocumentIndenterClassName()
  - saveAs
```
public static void saveAs(Document document,
                          File file)
                   throws IOException
```
    Save specified document to specified file using default SaveOptions.
    Unlike save(Document, File), the links to resources and to inclusions found in the document to be saved are possibly modified prior to saving it in order no to break these links.
    
    Parameters:
    
    document - Document to be saved.
    
    file - The save file.
    
    Throws:
    
    IOException - if, for any reason, the document cannot be saved.
    
    See Also:
    
    prepareSaveAs(com.xmlmind.xml.doc.Document, java.net.URL), Constants.DOCUMENT_RESOURCES_PROPERTY
  - prepareSaveAs
```
public static boolean prepareSaveAs(Document document,
                                    URL saveURL)
```
    Modifies the document to be saved prior to a ``save as'' operation.
    Example: document /home/john/doc1.xml is about to be saved as /home/john/docs/doc1.xml. Document doc1.xml points to resource<image source="images/logo.png"/>. prepareSaveAs will replace source="images/logo.png" by source="../images/logo.png". This way, after saving doc1.xml as /home/john/docs/doc1.xml, the link to this image resource is not broken.
    
    Parameters:
    
    document - A document about to be ``saved as''.
    
    saveURL - The ``save as'' URL.
    
    Returns:
    
    true if the document has been actually modified in order to prepare it for a ``save as'' operation; false otherwise
    
    See Also:
    
    saveAs(com.xmlmind.xml.doc.Document, java.io.File), Constants.DOCUMENT_RESOURCES_PROPERTY
  - prepareSaveAs2
```
public static void prepareSaveAs2(Document document,
                                  ResourceSelector[] resourceSpecs,
                                  URL docURL,
                                  URL saveURL,
                                  boolean[] modified)
```
    Not part of the public documented API: update references to resources in the document to be saved prior to a ``save as'' operation.
    saveURL may be null, an option which means: replace all relative resource URLs by absolute resource URLs.

Class SaveDocument

Method Summary

Methods inherited from class java.lang.Object

Method Detail

save

save

save

save

writeXMLDeclaration

createDocumentWriter

save

save

save

save

toString

toString

setDocumentWriterClassName

getDocumentWriterClassName

createDocumentWriter

setDocumentIndenterClassName

getDocumentIndenterClassName

createDocumentIndenter

saveAs

prepareSaveAs

prepareSaveAs2