org.exolab.castor.xml
Interface OutputFormat

All Known Implementing Classes:

WeblogicXercesOutputFormat, XercesJDK5OutputFormat, XercesOutputFormat

public interface OutputFormat

Output format contract for XML serialization.

Author:

Werner Guttmann

Field Summary

static java.lang.String

XML Default serialization method, being XML

Method Summary

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.

Field Detail

XML

public static final java.lang.String XML

Default serialization method, being XML

See Also:

Constant Field Values

Method Detail

setMethod

public void setMethod(java.lang.String method)

Set serialization method.

Parameters:

method - Required serialization method.

setIndenting

public void setIndenting(boolean indent)

Specify whether indentation is required

Parameters:

indent - true if XML output should be intended.

setPreserveSpace

public void setPreserveSpace(boolean preserveSpace)

Indicate whether white space should be preserved.

Parameters:

preserveSpace - True if white space should be preserved

getFormat

public java.lang.Object getFormat()

Returns the (underlying) OutputFormat instance

Returns:

the (underlying) OutputFormat instance

setDoctype

public void setDoctype(java.lang.String type1,
                       java.lang.String type2)

Defines the doc types to use.

Parameters:

type1 - Public DOC type.

type2 - System doc type.

setOmitXMLDeclaration

public void setOmitXMLDeclaration(boolean omitXMLDeclaration)

Indicates whether to omit XML declaration.

Parameters:

omitXMLDeclaration - True if XMl declaration should be omitted.

setOmitDocumentType

public void setOmitDocumentType(boolean omitDocumentType)

Indicates whether to omit DOCTYPE definition.

Parameters:

omitDocumentType - True if DOCTYPE definition should be omitted.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding to use.

Parameters:

encoding - The encoding to use.