org.exolab.castor.xml

Interface OutputFormat

public interface OutputFormat

Output format contract for XML serialization.

Author: Werner Guttmann

Field Summary
static StringXML
Default serialization method, being XML
Method Summary
ObjectgetFormat()
Returns the (underlying) OutputFormat instance
voidsetDoctype(String type1, String type2)
Defines the doc types to use.
voidsetEncoding(String encoding)
Sets the encoding to use.
voidsetIndenting(boolean indent)
Specify whether indentation is required
voidsetMethod(String method)
Set serialization method.
voidsetOmitDocumentType(boolean omitDocumentType)
Indicates whether to omit DOCTYPE definition.
voidsetOmitXMLDeclaration(boolean omitXMLDeclaration)
Indicates whether to omit XML declaration.
voidsetPreserveSpace(boolean preserveSpace)
Indicate whether white space should be preserved.

Field Detail

XML

public static final String XML
Default serialization method, being XML

Method Detail

getFormat

public Object getFormat()
Returns the (underlying) OutputFormat instance

Returns: the (underlying) OutputFormat instance

setDoctype

public void setDoctype(String type1, String type2)
Defines the doc types to use.

Parameters: type1 Public DOC type. type2 System doc type.

setEncoding

public void setEncoding(String encoding)
Sets the encoding to use.

Parameters: encoding The encoding to use.

setIndenting

public void setIndenting(boolean indent)
Specify whether indentation is required

Parameters: indent true if XML output should be intended.

setMethod

public void setMethod(String method)
Set serialization method.

Parameters: method Required serialization method.

setOmitDocumentType

public void setOmitDocumentType(boolean omitDocumentType)
Indicates whether to omit DOCTYPE definition.

Parameters: omitDocumentType True if DOCTYPE definition should be omitted.

setOmitXMLDeclaration

public void setOmitXMLDeclaration(boolean omitXMLDeclaration)
Indicates whether to omit XML declaration.

Parameters: omitXMLDeclaration True if XMl declaration should be omitted.

setPreserveSpace

public void setPreserveSpace(boolean preserveSpace)
Indicate whether white space should be preserved.

Parameters: preserveSpace True if white space should be preserved

Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com