Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
AccessType Enum
Address Class
Answers Class
ApexPages Class
Approval Class
Blob Class
Boolean Class
BusinessHours Class
Callable Interface
Cases Class
Comparable Interface
Continuation Class
Cookie Class
Crypto Class
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Double Class
EncodingUtil Class
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
FlexQueue Class
FeatureManagement Class
Formula Class
FormulaRecalcFieldError Class
FormulaRecalcResult Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Limits Class
List Class
Location Class
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
OrgLimit Class
OrgLimits Class
PageReference Class
Packaging Class
Pattern Class
Queueable Interface
QueueableContext Interface
QuickAction Class
Quiddity Enum
RemoteObjectController
Request Class
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
Security Class
SelectOption Class
Set Class
Site Class
SObject Class
SObjectAccessDecision Class
StaticResourceCalloutMock Class
String Class
StubProvider Interface
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
TriggerOperation Enum
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
UserManagement Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
XmlStreamWriter Constructors
XmlStreamWriter Methods
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

XmlStreamWriter Class

The XmlStreamWriter class provides methods for writing XML data.

Namespace

System

Usage

You can use the XmlStreamWriter class to programmatically construct an XML document, then use HTTP classes to send the document to an external server.

The XmlStreamWriter class is similar to the XMLStreamWriter utility class from StAX.

The XmlStreamWriter class in Apex is based on its counterpart in Java. See the Java XMLStreamWriter class.

Note

XmlStreamWriter Constructors

The following are constructors for XmlStreamWriter.

XmlStreamWriter()

Creates a new instance of the XmlStreamWriter class.

Signature

public XmlStreamWriter()

XmlStreamWriter Methods

The following are methods for XmlStreamWriter. All are instance methods.

close()

Closes this instance of an XmlStreamWriter and free any resources associated with it.

Signature

public Void close()

Return Value

Type: Void

getXmlString()

Returns the XML written by the XmlStreamWriter instance.

Signature

public String getXmlString()

Return Value

Type: String

setDefaultNamespace(uri)

Binds the specified URI to the default namespace. This URI is bound in the scope of the current START_ELEMENT – END_ELEMENT pair.

Signature

public Void setDefaultNamespace(String uri)

Parameters

uri
Type: String

Return Value

Type: Void

writeAttribute(prefix, namespaceUri, localName, value)

Writes an attribute to the output stream.

Signature

public Void writeAttribute(String prefix, String namespaceUri, String localName, String value)

Parameters

prefix
Type: String
namespaceUri
Type: String
localName
Type: String
Specifies the name of the attribute.
value
Type: String

Return Value

Type: Void

writeCData(data)

Writes the specified CData to the output stream.

Signature

public Void writeCData(String data)

Parameters

data
Type: String

Return Value

Type: Void

writeCharacters(text)

Writes the specified text to the output stream.

Signature

public Void writeCharacters(String text)

Parameters

text
Type: String

Return Value

Type: Void

writeComment(comment)

Writes the specified comment to the output stream.

Signature

public Void writeComment(String comment)

Parameters

comment
Type: String

Return Value

Type: Void

writeDefaultNamespace(namespaceUri)

Writes the specified namespace to the output stream.

Signature

public Void writeDefaultNamespace(String namespaceUri)

Parameters

namespaceUri
Type: String

Return Value

Type: Void

writeEmptyElement(prefix, localName, namespaceUri)

Writes an empty element tag to the output stream.

Signature

public Void writeEmptyElement(String prefix, String localName, String namespaceUri)

Parameters

prefix
Type: String
localName
Type: String
Specifies the name of the tag to be written.
namespaceUri
Type: String

Return Value

Type: Void

writeEndDocument()

Closes any start tags and writes corresponding end tags to the output stream.

Signature

public Void writeEndDocument()

Return Value

Type: Void

writeEndElement()

Writes an end tag to the output stream, relying on the internal state of the writer to determine the prefix and local name.

Signature

public Void writeEndElement()

Return Value

Type: Void

writeNamespace(prefix, namespaceUri)

Writes the specified namespace to the output stream.

Signature

public Void writeNamespace(String prefix, String namespaceUri)

Parameters

prefix
Type: String
namespaceUri
Type: String

Return Value

Type: Void

writeProcessingInstruction(target, data)

Writes the specified processing instruction.

Signature

public Void writeProcessingInstruction(String target, String data)

Parameters

target
Type: String
data
Type: String

Return Value

Type: Void

writeStartDocument(encoding, version)

Writes the XML Declaration using the specified XML encoding and version.

Signature

public Void writeStartDocument(String encoding, String version)

Parameters

encoding
Type: String
version
Type: String

Return Value

Type: Void

writeStartElement(prefix, localName, namespaceUri)

Writes the start tag specified by localName to the output stream.

Signature

public Void writeStartElement(String prefix, String localName, String namespaceUri)

Parameters

prefix
Type: String
localName
Type: String
namespaceUri
Type: String

Return Value

Type: Void