XMLBasedDoc (com.hfg API Documentation)

java.lang.Object
- com.hfg.xml.XMLBasedDoc<T>

Direct Known Subclasses:

HTMLDoc, SvgDoc, XMLDoc
```
public abstract class XMLBasedDoc<T extends XMLNode>
extends Object
```
Abstract base XML / HTML document.

Field Summary

Fields
Modifier and Type Field and Description

protected static String NL

Fields
Modifier and Type	Field and Description
`protected static String`	`NL`

Constructor Summary

Constructors
Constructor and Description
`XMLBasedDoc()`
`XMLBasedDoc(BufferedInputStream inStream)` The preferred way to read XML from a stream.
`XMLBasedDoc(BufferedReader inReader)`
`XMLBasedDoc(File inFile)` The preferred way to read XML from a file.
`XMLBasedDoc(XMLNode inRootNode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XMLBasedDoc`	`clone()`
`Doctype`	`getDoctype()`
`Charset`	`getEncoding()`
`String`	`getHeader()`
`XMLNode`	`getRootNode()`
`protected XMLTagReader`	`getTagReader()`
`List<XMLComment>`	`getTopLevelComments()`
`protected boolean`	`isConstructedContent()`
`String`	`name()`
`protected void`	`prepareForOutput()`
`void`	`replaceCharacterEntities()`
`XMLBasedDoc`	`setDoctype(Doctype inValue)`
`XMLBasedDoc`	`setEncoding(Charset inValue)`
`XMLBasedDoc`	`setIsStandalone(boolean inValue)`
`XMLBasedDoc`	`setName(String inValue)`
`void`	`setRootNode(XMLNode inRootNode)`
`XMLBasedDoc`	`setSpec(XMLSpec inValue)`
`void`	`toIndentedXML(File inFile, int inInitialIndentLevel, int inIndentSize)` The preferred way to save XML to a file.
`String`	`toIndentedXML(int inInitialIndentLevel, int inIndentSize)`
`void`	`toIndentedXML(OutputStream inStream, int inInitialIndentLevel, int inIndentSize)` Writes an indented form of the XML document to the specified OutputStream.
`void`	`toIndentedXML(Writer inWriter, int inInitialIndentLevel, int inIndentSize)` Writes an indented form of the XML document to the specified Writer.
`String`	`toXML()`
`void`	`toXML(File inFile)` The preferred way to save XML to a file.
`void`	`toXML(OutputStream inStream)`
`void`	`toXML(Writer inWriter)` Writes the XML document to the specified Writer.

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

Field Detail
- NL
```
protected static final String NL
```

Constructor Detail

XMLBasedDoc
```
public XMLBasedDoc()
```

XMLBasedDoc

public XMLBasedDoc(XMLNode inRootNode)

XMLBasedDoc
```
public XMLBasedDoc(File inFile)
            throws XMLException,
                   IOException
```
The preferred way to read XML from a file.

Parameters:

inFile - The XML file to read.

Throws:

XMLException

IOException

XMLBasedDoc

public XMLBasedDoc(BufferedReader inReader)

XMLBasedDoc
```
public XMLBasedDoc(BufferedInputStream inStream)
```
The preferred way to read XML from a stream.

Method Detail
- setName
```
public XMLBasedDoc setName(String inValue)
```
- name
```
public String name()
```
- clone
```
public XMLBasedDoc clone()
```
  Overrides:
  
  clone in class Object
- setSpec
```
public XMLBasedDoc setSpec(XMLSpec inValue)
```
- setEncoding
```
public XMLBasedDoc setEncoding(Charset inValue)
```
- getEncoding
```
public Charset getEncoding()
```
- setIsStandalone
```
public XMLBasedDoc setIsStandalone(boolean inValue)
```
- setDoctype
```
public XMLBasedDoc setDoctype(Doctype inValue)
```
- getDoctype
```
public Doctype getDoctype()
```
- getTopLevelComments
```
public List<XMLComment> getTopLevelComments()
```
- setRootNode
```
public void setRootNode(XMLNode inRootNode)
```
- getRootNode
```
public XMLNode getRootNode()
```
- toXML
```
public String toXML()
```
  Returns:
  
  The XML String encoded in the scheme specified for the XMLDoc.
- toXML
```
public void toXML(File inFile)
```
  The preferred way to save XML to a file. Properly encodes the XML based on the specified Charset.
  
  Parameters:
  
  inFile - the File to which the XML should be written
- toXML
```
public void toXML(OutputStream inStream)
```
- toXML
```
public void toXML(Writer inWriter)
```
  Writes the XML document to the specified Writer. Note that the caller needs to have specified the Charset for the Writer if other than the default encoding is desired.
- toIndentedXML
```
public String toIndentedXML(int inInitialIndentLevel,
                            int inIndentSize)
```
- toIndentedXML
```
public void toIndentedXML(OutputStream inStream,
                          int inInitialIndentLevel,
                          int inIndentSize)
```
  Writes an indented form of the XML document to the specified OutputStream. Flushes but does not close the specified OutputStream after writing.
  
  Parameters:
  
  inStream - The OutputStream to which the XML will be written
  
  inInitialIndentLevel - The size of the initial indent
  
  inIndentSize - The number of spaces incremented for ea. indent level
- toIndentedXML
```
public void toIndentedXML(Writer inWriter,
                          int inInitialIndentLevel,
                          int inIndentSize)
```
  Writes an indented form of the XML document to the specified Writer. Note that the caller needs to have specified the Charset for the Writer if other than the default encoding is desired.
- toIndentedXML
```
public void toIndentedXML(File inFile,
                          int inInitialIndentLevel,
                          int inIndentSize)
```
  The preferred way to save XML to a file. Properly encodes the XML based on the specified Charset.
  
  Parameters:
  
  inFile - The target output file
  
  inInitialIndentLevel - The size of the initial indent
  
  inIndentSize - The number of spaces incremented for ea. indent level
- getHeader
```
public String getHeader()
```
- replaceCharacterEntities
```
public void replaceCharacterEntities()
```
- prepareForOutput
```
protected void prepareForOutput()
```
- isConstructedContent
```
protected boolean isConstructedContent()
```
- getTagReader
```
protected XMLTagReader getTagReader()
```

Class XMLBasedDoc<T extends XMLNode>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NL

Constructor Detail

XMLBasedDoc

XMLBasedDoc

XMLBasedDoc

XMLBasedDoc

XMLBasedDoc

Method Detail

setName

name

clone

setSpec

setEncoding

getEncoding

setIsStandalone

setDoctype

getDoctype

getTopLevelComments

setRootNode

getRootNode

toXML

toXML

toXML

toXML

toIndentedXML

toIndentedXML

toIndentedXML

toIndentedXML

getHeader

replaceCharacterEntities

prepareForOutput

isConstructedContent

getTagReader