BaseXercesOutputFormat (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.xml.BaseXercesOutputFormat

All Implemented Interfaces:

OutputFormat

Direct Known Subclasses:

XercesJDK5OutputFormat, XercesOutputFormat
```
public class BaseXercesOutputFormat
extends java.lang.Object
implements OutputFormat
```
Xerces-specific OutputFormat instance.

Version:

$Revision: 7951 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Werner Guttmann

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.Object _outputFormat
- Fields inherited from interface org.exolab.castor.xml.OutputFormat
  XML

Fields
Modifier and Type	Field	Description
`protected java.lang.Object`	`_outputFormat`

Constructor Summary

Constructors
Constructor Description

BaseXercesOutputFormat()

Constructors
Constructor	Description
`BaseXercesOutputFormat()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`getFormat()`	Returns the (underlying) OutputFormat instance
`void`	`setDoctype(java.lang.String type1, java.lang.String type2)`	Defines the doc types to use.
`void`	`setEncoding(java.lang.String encoding)`	Sets the encoding to use.
`void`	`setIndenting(boolean indent)`	Specify whether indentation is required
`void`	`setMethod(java.lang.String method)`	Set serialization method.
`void`	`setOmitDocumentType(boolean omitDocumentType)`	Indicates whether to omit DOCTYPE definition.
`void`	`setOmitXMLDeclaration(boolean omitXMLDeclaration)`	Indicates whether to omit XML declaration.
`void`	`setPreserveSpace(boolean preserveSpace)`	Indicate whether white space should be preserved.
`void`	`setVersion(java.lang.String version)`	Defines the XML document version to be output.

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

- Field Detail
  - _outputFormat
```
protected java.lang.Object _outputFormat
```
- Constructor Detail
  - BaseXercesOutputFormat
```
public BaseXercesOutputFormat()
```
- Method Detail
  - getFormat
```
public java.lang.Object getFormat()
```
    Description copied from interface: OutputFormat
    
    Returns the (underlying) OutputFormat instance
    
    Specified by:
    
    getFormat in interface OutputFormat
    
    Returns:
    
    the (underlying) OutputFormat instance
  - setMethod
```
public void setMethod(java.lang.String method)
```
    Description copied from interface: OutputFormat
    
    Set serialization method.
    
    Specified by:
    
    setMethod in interface OutputFormat
    
    Parameters:
    
    method - Required serialization method.
  - setIndenting
```
public void setIndenting(boolean indent)
```
    Description copied from interface: OutputFormat
    
    Specify whether indentation is required
    
    Specified by:
    
    setIndenting in interface OutputFormat
    
    Parameters:
    
    indent - true if XML output should be intended.
  - setPreserveSpace
```
public void setPreserveSpace(boolean preserveSpace)
```
    Description copied from interface: OutputFormat
    
    Indicate whether white space should be preserved.
    
    Specified by:
    
    setPreserveSpace in interface OutputFormat
    
    Parameters:
    
    preserveSpace - True if white space should be preserved
  - setDoctype
```
public void setDoctype(java.lang.String type1,
                       java.lang.String type2)
```
    Description copied from interface: OutputFormat
    
    Defines the doc types to use.
    
    Specified by:
    
    setDoctype in interface OutputFormat
    
    Parameters:
    
    type1 - Public DOC type.
    
    type2 - System doc type.
  - setOmitXMLDeclaration
```
public void setOmitXMLDeclaration(boolean omitXMLDeclaration)
```
    Description copied from interface: OutputFormat
    
    Indicates whether to omit XML declaration.
    
    Specified by:
    
    setOmitXMLDeclaration in interface OutputFormat
    
    Parameters:
    
    omitXMLDeclaration - True if XMl declaration should be omitted.
  - setOmitDocumentType
```
public void setOmitDocumentType(boolean omitDocumentType)
```
    Description copied from interface: OutputFormat
    
    Indicates whether to omit DOCTYPE definition.
    
    Specified by:
    
    setOmitDocumentType in interface OutputFormat
    
    Parameters:
    
    omitDocumentType - True if DOCTYPE definition should be omitted.
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    Description copied from interface: OutputFormat
    
    Sets the encoding to use.
    
    Specified by:
    
    setEncoding in interface OutputFormat
    
    Parameters:
    
    encoding - The encoding to use.
  - setVersion
```
public void setVersion(java.lang.String version)
```
    Description copied from interface: OutputFormat
    
    Defines the XML document version to be output.
    
    Specified by:
    
    setVersion in interface OutputFormat

Class BaseXercesOutputFormat

Field Summary

Fields inherited from interface org.exolab.castor.xml.OutputFormat

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_outputFormat

Constructor Detail

BaseXercesOutputFormat

Method Detail

getFormat

setMethod

setIndenting

setPreserveSpace

setDoctype

setOmitXMLDeclaration

setOmitDocumentType

setEncoding

setVersion