com.sun.xml.bind.v2.runtime.output.XMLStreamWriterOutput Maven / Gradle / Ivy
Show all versions of jaxb-runtime Show documentation
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.bind.v2.runtime.output;
import java.io.IOException;
import java.io.Writer;
import java.lang.reflect.Constructor;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import com.sun.xml.bind.marshaller.CharacterEscapeHandler;
import com.sun.xml.bind.marshaller.NoEscapeHandler;
import com.sun.xml.bind.v2.runtime.JAXBContextImpl;
import com.sun.xml.bind.v2.runtime.XMLSerializer;
import org.xml.sax.SAXException;
/**
* {@link XmlOutput} that writes to StAX {@link XMLStreamWriter}.
*
* TODO:
* Finding the optimized FI implementations is a bit hacky and not very
* extensible. Can we use the service provider mechanism in general for
* concrete implementations of XmlOutputAbstractImpl.
*
* @author Kohsuke Kawaguchi
*/
public class XMLStreamWriterOutput extends XmlOutputAbstractImpl {
/**
* Creates a new {@link XmlOutput} from a {@link XMLStreamWriter}.
* This method recognizes an FI StAX writer.
*/
public static XmlOutput create(XMLStreamWriter out, JAXBContextImpl context, CharacterEscapeHandler escapeHandler) {
// try optimized path
final Class writerClass = out.getClass();
if (writerClass==FI_STAX_WRITER_CLASS) {
try {
return FI_OUTPUT_CTOR.newInstance(out, context);
} catch (Exception e) {
}
}
if (STAXEX_WRITER_CLASS!=null && STAXEX_WRITER_CLASS.isAssignableFrom(writerClass)) {
try {
return STAXEX_OUTPUT_CTOR.newInstance(out);
} catch (Exception e) {
}
}
CharacterEscapeHandler xmlStreamEscapeHandler = escapeHandler != null ?
escapeHandler : NoEscapeHandler.theInstance;
// otherwise the normal writer.
return new XMLStreamWriterOutput(out, xmlStreamEscapeHandler);
}
private final XMLStreamWriter out;
private final CharacterEscapeHandler escapeHandler;
private final XmlStreamOutWriterAdapter writerWrapper;
protected final char[] buf = new char[256];
protected XMLStreamWriterOutput(XMLStreamWriter out, CharacterEscapeHandler escapeHandler) {
this.out = out;
this.escapeHandler = escapeHandler;
this.writerWrapper = new XmlStreamOutWriterAdapter(out);
}
// not called if we are generating fragments
@Override
public void startDocument(XMLSerializer serializer, boolean fragment, int[] nsUriIndex2prefixIndex, NamespaceContextImpl nsContext) throws IOException, SAXException, XMLStreamException {
super.startDocument(serializer, fragment,nsUriIndex2prefixIndex,nsContext);
if(!fragment)
out.writeStartDocument();
}
@Override
public void endDocument(boolean fragment) throws IOException, SAXException, XMLStreamException {
if(!fragment) {
out.writeEndDocument();
out.flush();
}
super.endDocument(fragment);
}
public void beginStartTag(int prefix, String localName) throws IOException, XMLStreamException {
out.writeStartElement(
nsContext.getPrefix(prefix),
localName,
nsContext.getNamespaceURI(prefix));
NamespaceContextImpl.Element nse = nsContext.getCurrent();
if(nse.count()>0) {
for( int i=nse.count()-1; i>=0; i-- ) {
String uri = nse.getNsUri(i);
if(uri.length()==0 && nse.getBase()==1)
continue; // no point in definint xmlns='' on the root
out.writeNamespace(nse.getPrefix(i),uri);
}
}
}
public void attribute(int prefix, String localName, String value) throws IOException, XMLStreamException {
if(prefix==-1)
out.writeAttribute(localName,value);
else
out.writeAttribute(
nsContext.getPrefix(prefix),
nsContext.getNamespaceURI(prefix),
localName, value);
}
public void endStartTag() throws IOException, SAXException {
// noop
}
public void endTag(int prefix, String localName) throws IOException, SAXException, XMLStreamException {
out.writeEndElement();
}
public void text(String value, boolean needsSeparatingWhitespace) throws IOException, SAXException, XMLStreamException {
if(needsSeparatingWhitespace)
out.writeCharacters(" ");
escapeHandler.escape(value.toCharArray(), 0, value.length(), false, writerWrapper);
}
public void text(Pcdata value, boolean needsSeparatingWhitespace) throws IOException, SAXException, XMLStreamException {
if(needsSeparatingWhitespace)
out.writeCharacters(" ");
int len = value.length();
if(len FI_OUTPUT_CTOR = initFastInfosetOutputClass();
private static Class initFIStAXWriterClass() {
try {
Class llfisw = Class.forName("org.jvnet.fastinfoset.stax.LowLevelFastInfosetStreamWriter");
Class sds = Class.forName("com.sun.xml.fastinfoset.stax.StAXDocumentSerializer");
// Check if StAXDocumentSerializer implements LowLevelFastInfosetStreamWriter
if (llfisw.isAssignableFrom(sds))
return sds;
else
return null;
} catch (Throwable e) {
return null;
}
}
private static Constructor initFastInfosetOutputClass() {
try {
if (FI_STAX_WRITER_CLASS == null)
return null;
Class c = Class.forName("com.sun.xml.bind.v2.runtime.output.FastInfosetStreamWriterOutput");
return c.getConstructor(FI_STAX_WRITER_CLASS, JAXBContextImpl.class);
} catch (Throwable e) {
return null;
}
}
//
// StAX-ex
//
private static final Class STAXEX_WRITER_CLASS = initStAXExWriterClass();
private static final Constructor STAXEX_OUTPUT_CTOR = initStAXExOutputClass();
private static Class initStAXExWriterClass() {
try {
return Class.forName("org.jvnet.staxex.XMLStreamWriterEx");
} catch (Throwable e) {
return null;
}
}
private static Constructor initStAXExOutputClass() {
try {
Class c = Class.forName("com.sun.xml.bind.v2.runtime.output.StAXExStreamWriterOutput");
return c.getConstructor(STAXEX_WRITER_CLASS);
} catch (Throwable e) {
return null;
}
}
private static final class XmlStreamOutWriterAdapter extends Writer {
private final XMLStreamWriter writer;
private XmlStreamOutWriterAdapter(XMLStreamWriter writer) {
this.writer = writer;
}
@Override
public void write(char[] cbuf, int off, int len) throws IOException {
try {
writer.writeCharacters(cbuf, off, len);
} catch (XMLStreamException e) {
throw new IOException("Error writing XML stream", e);
}
}
public void writeEntityRef(String entityReference) throws XMLStreamException {
writer.writeEntityRef(entityReference);
}
@Override
public void flush() throws IOException {
try {
writer.flush();
} catch (XMLStreamException e) {
throw new IOException("Error flushing XML stream", e);
}
}
@Override
public void close() throws IOException {
try {
writer.close();
} catch (XMLStreamException e) {
throw new IOException("Error closing XML stream", e);
}
}
}
}