Class OutputStreamRecord
- All Implemented Interfaces:
AbstractMarshalRecord<CoreAbstractSession,
,CoreField, XMLMarshaller, NamespaceResolver> MarshalRecord<CoreAbstractSession,
,CoreField, XMLMarshaller, NamespaceResolver> XMLRecord<CoreAbstractSession>
- Direct Known Subclasses:
FormattedOutputStreamRecord
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);
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
This class will typically be used in conjunction with an XMLFragmentReader.Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
MarshalRecord.CycleDetectionStack<E>
Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord
XMLRecord.Nil
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final byte[]
protected static final byte
protected static final byte[]
protected static final byte[]
protected static final byte
protected static final byte[]
protected static final byte[]
protected static final byte[]
protected boolean
protected boolean
protected static final byte[]
protected static final byte[]
protected static final byte[]
protected static final byte[]
protected static final byte
protected static final byte[]
protected OutputStream
protected static final byte[]
protected static final byte[]
protected static final byte[]
protected static final byte
Fields inherited from class org.eclipse.persistence.oxm.record.MarshalRecord
COLON_W_SCHEMA_NIL_ATTRIBUTE, textWrapperFragment, TRUE
Fields inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
equalNamespaceResolvers, hasCustomNamespaceMapper, marshaller, namespaceAware, namespaceResolver, session
Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord
DEFAULT_ATTRIBUTE_GROUP, NIL
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
INTERNAL:void
attribute
(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, String value) INTERNAL:void
INTERNAL:void
characters
(String value) INTERNAL:void
INTERNAL:void
element
(XPathFragment frag) INTERNAL:void
INTERNAL:void
endElement
(XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:void
flush()
Return the OutputStream that the object will be marshalled to.void
node
(Node node, NamespaceResolver namespaceResolver, String uri, String localName) Receive notification of a node.void
openStartElement
(XPathFragment xPathFragment, NamespaceResolver namespaceResolver) INTERNAL:protected void
outputStreamWrite
(byte aByte) protected void
outputStreamWrite
(byte[] bytes) protected void
outputStreamWrite
(byte[] bytes, OutputStream os) protected void
outputStreamWrite
(byte aByte, OutputStream os) void
setOutputStream
(OutputStream outputStream) Set the OutputStream that the object will be marshalled to.void
startDocument
(String encoding, String version) INTERNAL:void
startPrefixMappings
(NamespaceResolver namespaceResolver) INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anythingvoid
INTERNALprotected void
writeValue
(String value, boolean escapeChars) INTERNAL:protected void
writeValue
(String value, boolean escapeChars, boolean isAttribute, OutputStream os) INTERNAL:Methods inherited from class org.eclipse.persistence.oxm.record.MarshalRecord
add, addGroupingElement, addPositionalNodes, afterContainmentMarshal, attribute, beforeContainmentMarshal, characters, clear, closeStartGroupingElements, defaultNamespaceDeclaration, emptyAttribute, emptyCollection, emptyComplex, emptySimple, endCollection, endPrefixMapping, endPrefixMappings, forceValueWrapper, getCurrentAttributeGroup, getCycleDetectionStack, getDocument, getDOM, getGroupingElements, getLocalName, getNameForFragment, getNamespaceURI, getPositionalNodes, getPrefixBytes, getPrefixForFragment, getStringForQName, getTextWrapperFragment, getValueToWrite, isWrapperAsCollectionName, marshalWithoutRootElement, namespaceDeclaration, namespaceDeclarations, nilComplex, nilSimple, node, openStartGroupingElements, popAttributeGroup, predicateAttribute, processNamespaceResolverForXSIPrefix, pushAttributeGroup, put, removeGroupingElement, setGroupingElement, setSession, startCollection, startPrefixMapping, transformToXML
Methods inherited from class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
addExtraNamespacesToNamespaceResolver, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, hasEqualNamespaceResolvers, isNamespaceAware, resolveNamespacePrefix, setCustomNamespaceMapper, setEqualNamespaceResolvers, setLeafElementType, setNamespaceResolver, setOwningObject, setXOPPackage, writeXsiTypeAttribute, writeXsiTypeAttribute
Methods inherited from interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
attributeWithoutQName, hasCustomNamespaceMapper, isXOPPackage, removeExtraNamespacesFromNamespaceResolver, setLeafElementType, setMarshaller
Methods inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord
getConversionManager, getNamespaceSeparator, getSession
-
Field Details
-
OPEN_XML_PI_AND_VERSION_ATTRIBUTE
protected static final byte[] OPEN_XML_PI_AND_VERSION_ATTRIBUTE -
OPEN_ENCODING_ATTRIBUTE
protected static final byte[] OPEN_ENCODING_ATTRIBUTE -
CLOSE_PI
protected static final byte[] CLOSE_PI -
SPACE
protected static final byte SPACE- See Also:
-
CLOSE_ATTRIBUTE_VALUE
protected static final byte CLOSE_ATTRIBUTE_VALUE- See Also:
-
OPEN_CDATA
protected static final byte[] OPEN_CDATA -
CLOSE_CDATA
protected static final byte[] CLOSE_CDATA -
OPEN_COMMENT
protected static final byte[] OPEN_COMMENT -
CLOSE_COMMENT
protected static final byte[] CLOSE_COMMENT -
OPEN_START_ELEMENT
protected static final byte OPEN_START_ELEMENT- See Also:
-
CLOSE_ELEMENT
protected static final byte CLOSE_ELEMENT- See Also:
-
AMP
protected static final byte[] AMP -
LT
protected static final byte[] LT -
GT
protected static final byte[] GT -
QUOT
protected static final byte[] QUOT -
ENCODING
protected static final byte[] ENCODING -
SLASH_N
protected static final byte[] SLASH_N -
SLASH_R
protected static final byte[] SLASH_R -
outputStream
-
isStartElementOpen
protected boolean isStartElementOpen -
isProcessingCData
protected boolean isProcessingCData
-
-
Constructor Details
-
OutputStreamRecord
public OutputStreamRecord()
-
-
Method Details
-
getOutputStream
Return the OutputStream that the object will be marshalled to.- Returns:
- The marshal target.
-
setOutputStream
Set the OutputStream that the object will be marshalled to.- Parameters:
outputStream
- The marshal target.
-
startPrefixMappings
INTERNAL: override so we don't iterate over namespaces when startPrefixMapping doesn't do anything- Overrides:
startPrefixMappings
in classMarshalRecord<XMLMarshaller>
-
startDocument
INTERNAL:- Specified by:
startDocument
in classMarshalRecord<XMLMarshaller>
- Parameters:
encoding
- The XML document will be encoded using this encoding.version
- This specifies the version of XML.
-
writeHeader
public void writeHeader()INTERNAL- Overrides:
writeHeader
in classMarshalRecord<XMLMarshaller>
-
endDocument
public void endDocument()INTERNAL:- Specified by:
endDocument
in classMarshalRecord<XMLMarshaller>
-
openStartElement
INTERNAL:- Specified by:
openStartElement
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Overrides:
openStartElement
in classMarshalRecord<XMLMarshaller>
- Parameters:
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).
-
element
INTERNAL:- Specified by:
element
in classMarshalRecord<XMLMarshaller>
- Parameters:
frag
- The XPathFragment of the element
-
attribute
public void attribute(XPathFragment xPathFragment, NamespaceResolver namespaceResolver, String value) INTERNAL:- Specified by:
attribute
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
attribute
in classMarshalRecord<XMLMarshaller>
- Parameters:
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.
-
attribute
INTERNAL:- Specified by:
attribute
in interfaceAbstractMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
attribute
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
attribute
in classMarshalRecord<XMLMarshaller>
- Parameters:
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.
-
closeStartElement
public void closeStartElement()INTERNAL:- Specified by:
closeStartElement
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
closeStartElement
in classMarshalRecord<XMLMarshaller>
-
endElement
INTERNAL:- Specified by:
endElement
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
endElement
in classMarshalRecord<XMLMarshaller>
- Parameters:
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).
-
characters
INTERNAL:- Specified by:
characters
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
characters
in classMarshalRecord<XMLMarshaller>
- Parameters:
value
- This is the entire value of the text node.
-
cdata
INTERNAL:- Specified by:
cdata
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Specified by:
cdata
in classMarshalRecord<XMLMarshaller>
- Parameters:
value
- This is the value of the text to be wrapped
-
writeValue
INTERNAL: -
writeValue
INTERNAL: -
node
Receive notification of a node.- Specified by:
node
in classMarshalRecord<XMLMarshaller>
- Parameters:
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 node
-
flush
public void flush()- Specified by:
flush
in interfaceMarshalRecord<CoreAbstractSession,
CoreField, XMLMarshaller, NamespaceResolver> - Overrides:
flush
in classMarshalRecord<XMLMarshaller>
-
outputStreamWrite
protected void outputStreamWrite(byte[] bytes) -
outputStreamWrite
-
outputStreamWrite
protected void outputStreamWrite(byte aByte) -
outputStreamWrite
-