Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle TopLink
11g Release 1 (11.1.1)

B32476-02


oracle.toplink.ox.record
Class FormattedWriterRecord

java.lang.Object
  extended by oracle.toplink.internal.sessions.AbstractRecord
      extended by oracle.toplink.ox.record.XMLRecord
          extended by oracle.toplink.ox.record.MarshalRecord
              extended by oracle.toplink.ox.record.WriterRecord
                  extended by oracle.toplink.ox.record.FormattedWriterRecord

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, Record

public class FormattedWriterRecord
extends WriterRecord

Use this type of MarshalRecord when the marshal target is a Writer and the XML should be formatted with carriage returns and indenting.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
FormattedWriterRecord formattedWriterRecord = new FormattedWriterRecord();
formattedWriterRecord.setWriter(myWriter);
xmlMarshaller.marshal(myObject, formattedWriterRecord);

If the marshal(Writer) and setFormattedOutput(true) method is called on XMLMarshaller, then the Writer is automatically wrapped in a FormattedWriterRecord.

XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller xmlMarshaller.setFormattedOutput(true);
xmlMarshaller.marshal(myObject, myWriter);

See Also:
XMLMarshaller, Serialized Form

Nested Class Summary

 

Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>

 

Constructor Summary
FormattedWriterRecord()
           

 

Method Summary
 void node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver)
          Receive notification of a node.

 

Methods inherited from class oracle.toplink.ox.record.WriterRecord
getWriter, setWriter

 

Methods inherited from class oracle.toplink.ox.record.MarshalRecord
clear, closeStartGroupingElements, endPrefixMapping, endPrefixMappings, getDocument, getDOM, getLocalName, getNamespaceURI, getPositionalNodes, startPrefixMapping, startPrefixMappings, transformToXML

 

Methods inherited from class oracle.toplink.ox.record.XMLRecord
contains, getDocPresPolicy, getNamespaceResolver, resolveNamespacePrefix, setDocPresPolicy, setNamespaceResolver

 

Methods inherited from class oracle.toplink.internal.sessions.AbstractRecord
containsKey, containsKey, containsValue, elements, entrySet, get, get, getValues, getValues, isEmpty, keys, keySet, put, put, putAll, size, values

 

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

 

Methods inherited from interface java.util.Map
equals, hashCode

 

Constructor Detail

FormattedWriterRecord

public FormattedWriterRecord()

Method Detail

node

public void node(org.w3c.dom.Node node,
                 NamespaceResolver namespaceResolver)
Receive notification of a node.
Overrides:
node in class WriterRecord
Parameters:
node - The Node to be added to the document
namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI/prefix of the node

Skip navigation links

Copyright © 1998, 2009, Oracle. All Rights Reserved.