- java.lang.Object
-
- javax.xml.transform.stax.StAXResult
-
- All Implemented Interfaces:
- Result
public class StAXResult extends Object implements Result
Acts as a holder for an XML
Result
in the form of a StAX writer,i.e.XMLStreamWriter
orXMLEventWriter
.StAXResult
can be used in all cases that accept aResult
, e.g.Transformer
,Validator
which acceptResult
as input.- Since:
- 1.6
- See Also:
-
JSR 173: Streaming API for XML,
XMLStreamWriter
,XMLEventWriter
-
-
Field Summary
Fields Modifier and Type Field and Description static String
FEATURE
IfTransformerFactory.getFeature(String name)
returns true when passed this value as an argument, the Transformer supports Result output of this type.-
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
-
Constructor Summary
Constructors Constructor and Description StAXResult(XMLEventWriter xmlEventWriter)
Creates a new instance of aStAXResult
by supplying anXMLEventWriter
.StAXResult(XMLStreamWriter xmlStreamWriter)
Creates a new instance of aStAXResult
by supplying anXMLStreamWriter
.
-
Method Summary
Methods Modifier and Type Method and Description String
getSystemId()
The returned system identifier is alwaysnull
.XMLEventWriter
getXMLEventWriter()
Get theXMLEventWriter
used by thisStAXResult
.XMLStreamWriter
getXMLStreamWriter()
Get theXMLStreamWriter
used by thisStAXResult
.void
setSystemId(String systemId)
In the context of aStAXResult
, it is not appropriate to explicitly set the system identifier.
-
-
-
Field Detail
-
FEATURE
public static final String FEATURE
IfTransformerFactory.getFeature(String name)
returns true when passed this value as an argument, the Transformer supports Result output of this type.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StAXResult
public StAXResult(XMLEventWriter xmlEventWriter)
Creates a new instance of a
StAXResult
by supplying anXMLEventWriter
.XMLEventWriter
must be a non-null
reference.- Parameters:
xmlEventWriter
-XMLEventWriter
used to create thisStAXResult
.- Throws:
IllegalArgumentException
- IfxmlEventWriter
==null
.
-
StAXResult
public StAXResult(XMLStreamWriter xmlStreamWriter)
Creates a new instance of a
StAXResult
by supplying anXMLStreamWriter
.XMLStreamWriter
must be a non-null
reference.- Parameters:
xmlStreamWriter
-XMLStreamWriter
used to create thisStAXResult
.- Throws:
IllegalArgumentException
- IfxmlStreamWriter
==null
.
-
-
Method Detail
-
getXMLEventWriter
public XMLEventWriter getXMLEventWriter()
Get the
XMLEventWriter
used by thisStAXResult
.XMLEventWriter
will benull
if thisStAXResult
was created with aXMLStreamWriter
.- Returns:
XMLEventWriter
used by thisStAXResult
.
-
getXMLStreamWriter
public XMLStreamWriter getXMLStreamWriter()
Get the
XMLStreamWriter
used by thisStAXResult
.XMLStreamWriter
will benull
if thisStAXResult
was created with aXMLEventWriter
.- Returns:
XMLStreamWriter
used by thisStAXResult
.
-
setSystemId
public void setSystemId(String systemId)
In the context of a
StAXResult
, it is not appropriate to explicitly set the system identifier. TheXMLEventWriter
orXMLStreamWriter
used to construct thisStAXResult
determines the system identifier of the XML result.An
UnsupportedOperationException
is always thrown by this method.- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- Ignored.- Throws:
UnsupportedOperationException
- Is always thrown by this method.
-
getSystemId
public String getSystemId()
The returned system identifier is always
null
.- Specified by:
getSystemId
in interfaceResult
- Returns:
- The returned system identifier is always
null
.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 15:43:33 Cette version de la page est en cache (à la date du 22/12/2024 15:43:33) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/transform/stax/StAXResult.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.