public class OutputStreamRecord extends MarshalRecord<XMLMarshaller>
Use this type of MarshalRecord when the marshal target is an OutputStream and the XML should not be formatted with carriage returns or indenting. This type is only used if the encoding of the OutputStream is UTF-8
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
OutputStreamRecord record = new OutputStreamRecord();
record.setOutputStream(myOutputStream);
xmlMarshaller.marshal(myObject, record);
If the marshal(OutputStream) and setFormattedOutput(false) method is called on XMLMarshaller and the encoding is UTF-8, then the OutputStream is automatically wrapped in an OutputStream.
XMLContext xmlContext = new XMLContext("session-name");
XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
xmlMarshaller xmlMarshaller.setFormattedOutput(false);
xmlMarshaller.marshal(myObject, myOutputStream);
XMLMarshaller
MarshalRecord.CycleDetectionStack<E>
XMLRecord.Nil
DEFAULT_ATTRIBUTE_GROUP, NIL
Constructor and Description |
---|
OutputStreamRecord() |
Modifier and Type | Method and Description |
---|---|
void |
attribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
java.lang.String value)
INTERNAL:
|
void |
attribute(XPathFragment xPathFragment,
NamespaceResolver namespaceResolver,
java.lang.String value)
INTERNAL:
|
void |
cdata(java.lang.String value)
INTERNAL:
|
void |
characters(java.lang.String value)
INTERNAL:
|
void |
closeStartElement()
INTERNAL:
|
void |
element(XPathFragment frag)
INTERNAL:
|
void |
endDocument()
INTERNAL:
|
void |
endElement(XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
INTERNAL:
|
void |
flush() |
java.io.OutputStream |
getOutputStream()
Return the OutputStream that the object will be marshalled to.
|
void |
node(org.w3c.dom.Node node,
NamespaceResolver namespaceResolver,
java.lang.String uri,
java.lang.String localName)
Receive notification of a node.
|
void |
openStartElement(XPathFragment xPathFragment,
NamespaceResolver namespaceResolver)
INTERNAL:
|
void |
setOutputStream(java.io.OutputStream outputStream)
Set the OutputStream that the object will be marshalled to.
|
void |
startDocument(java.lang.String encoding,
java.lang.String version)
INTERNAL:
|
void |
startPrefixMappings(NamespaceResolver namespaceResolver)
INTERNAL:
override so we don't iterate over namespaces when startPrefixMapping doesn't do anything
|
void |
writeHeader()
INTERNAL
|
add, addGroupingElement, afterContainmentMarshal, attribute, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, defaultNamespaceDeclaration, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endCollection, endPrefixMapping, endPrefixMappings, forceValueWrapper, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNamespaceURI, getPositionalNodes, getTextWrapperFragment, getValueToWrite, isWrapperAsCollectionName, marshalWithoutRootElement, namespaceDeclaration, namespaceDeclarations, nilComplex, nilSimple, node, openStartGroupingElements, popAttributeGroup, predicateAttribute, pushAttributeGroup, put, removeGroupingElement, setGroupingElement, setSession, startCollection, startPrefixMapping, transformToXML
addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, attributeWithoutQName, getConversionManager, getLeafElementType, getMarshaller, getNamespaceResolver, getNamespaceSeparator, getOwningObject, getSession, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
attributeWithoutQName, hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType, setMarshaller
addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, hasEqualNamespaceResolvers, isNamespaceAware, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute
getConversionManager, getNamespaceSeparator, getSession
public java.io.OutputStream getOutputStream()
public void setOutputStream(java.io.OutputStream outputStream)
outputStream
- The marshal target.public void startPrefixMappings(NamespaceResolver namespaceResolver)
startPrefixMappings
in class MarshalRecord<XMLMarshaller>
public void startDocument(java.lang.String encoding, java.lang.String version)
startDocument
in class MarshalRecord<XMLMarshaller>
encoding
- The XML document will be encoded using this encoding.version
- This specifies the version of XML.public void writeHeader()
writeHeader
in class MarshalRecord<XMLMarshaller>
public void endDocument()
endDocument
in class MarshalRecord<XMLMarshaller>
public void openStartElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
openStartElement
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
openStartElement
in class MarshalRecord<XMLMarshaller>
xPathFragment
- The XPathFragment contains the name and prefix
information about the XML element being ended.namespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI for the namespace prefix held by the XPathFragment (if
required).public void element(XPathFragment frag)
element
in class MarshalRecord<XMLMarshaller>
frag
- The XPathFragment of the elementpublic void attribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, java.lang.String value)
attribute
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
attribute
in class MarshalRecord<XMLMarshaller>
xPathFragment
- The XPathFragment contains the name and prefix
information about the XML element being ended.namespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI for the namespace prefix held by the XPathFragment (if
required).value
- This is the complete value for the attribute.public void attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value)
attribute
in interface AbstractMarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
attribute
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
attribute
in class MarshalRecord<XMLMarshaller>
namespaceURI
- The namespace URI, if the attribute is not namespace
qualified the value of this parameter wil be null.localName
- The local name of the attribute.qName
- The qualified name of the attribute.value
- This is the complete value for the attribute.public void closeStartElement()
closeStartElement
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
closeStartElement
in class MarshalRecord<XMLMarshaller>
public void endElement(XPathFragment xPathFragment, NamespaceResolver namespaceResolver)
endElement
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
endElement
in class MarshalRecord<XMLMarshaller>
xPathFragment
- The XPathFragment contains the name and prefix
information about the XML element being ended.namespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI for the namespace prefix held by the XPathFragment (if
required).public void characters(java.lang.String value)
characters
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
characters
in class MarshalRecord<XMLMarshaller>
value
- This is the entire value of the text node.public void cdata(java.lang.String value)
cdata
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
cdata
in class MarshalRecord<XMLMarshaller>
value
- This is the value of the text to be wrappedpublic void node(org.w3c.dom.Node node, NamespaceResolver namespaceResolver, java.lang.String uri, java.lang.String localName)
node
in class MarshalRecord<XMLMarshaller>
node
- The Node to be added to the documentnamespaceResolver
- The NamespaceResolver can be used to resolve the
namespace URI/prefix of the nodeuri
- replacement root name for the nodelocalName
- replacement root namespace for the node
namespace URI/prefix of the nodepublic void flush()
flush
in interface MarshalRecord<CoreAbstractSession,CoreField,XMLMarshaller,NamespaceResolver>
flush
in class MarshalRecord<XMLMarshaller>
EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference