aoqi@0: * Implementations of this interface is used to connect {@link XMLSerializer} aoqi@0: * to the actual target. This allows {@link XMLSerializer} to be API agnostic. aoqi@0: * aoqi@0: * aoqi@0: *
aoqi@0: * {@link JAXBContext} assigns indices to URIs and local names aoqi@0: * that are statically known by using {@link NameList}. aoqi@0: * {@link XmlOutput} implementation can use these indices to improve aoqi@0: * the performance. For example, those namespace URI indices can be aoqi@0: * turned into prefixes quickly. aoqi@0: * aoqi@0: *
aoqi@0: * {@link XmlOutput} still allows arbitrary namepsace URIs / local names aoqi@0: * to be written. aoqi@0: * aoqi@0: *
aoqi@0: * The {@link NamespaceContextImpl} object, which is shared between {@link XmlOutput} and aoqi@0: * {@link XMLSerializer}, keeps track of the in-scope namespace bindings. By the time aoqi@0: * the {@link #beginStartTag} method is called, all the namespace bindings for the new aoqi@0: * element is already declared. Similarly, after the {@link #endTag} method is called, aoqi@0: * in-scope bindings will be removed. This book keeping is all done outside {@link XmlOutput}. aoqi@0: * aoqi@0: *
aoqi@0: * {@link XmlOutput} and {@link XMLSerializer} uses indices to aoqi@0: * reference prefixes/URIs to be written. {@link NamespaceContextImpl} can aoqi@0: * convert prefix indices to URIs and the string representations of prefixes. aoqi@0: * Binding from indices to URIs and prefixes do not change while indices aoqi@0: * are "in scope", so {@link XmlOutput} is again expected to take advantage of aoqi@0: * this to improve the perofmrnace. aoqi@0: * aoqi@0: *
aoqi@0: * prefix index 0 is reserved for "xml", and this binding is assumed to be always there. aoqi@0: * {@link NamespaceContextImpl} can handle this index correctly, but this binding will never aoqi@0: * be reported to {@link XmlOutput} through {@link #beginStartTag}. aoqi@0: * aoqi@0: *
aoqi@0: * One pecurilar behavior of a {@link NamespaceContextImpl} object is that it tries aoqi@0: * to define redundant xmlns="" on the root element. Implementations of {@link XmlOutput} aoqi@0: * is encouraged to check for this and avoid generating redundant namespace declarations. aoqi@0: * aoqi@0: * aoqi@0: * aoqi@0: *
aoqi@0: * {@link XMLSerializer} calls the writer methods in the following order: aoqi@0: * aoqi@0: *
aoqi@0: * CALLSEQUENCE := {@link #startDocument startDocument} ELEMENT {@link #endDocument endDocument}
aoqi@0: * | ELEMENT // for fragment
aoqi@0: *
aoqi@0: * ELEMENT := {@link #beginStartTag beginStartTag} {@link #attribute attribute}* {@link #endStartTag endStartTag} CONTENTS {@link #endTag endTag}
aoqi@0: *
aoqi@0: * CONTENTS := (ELEMENT | {@link #text text})*
aoqi@0: *
aoqi@0: *
aoqi@0: * TODO: for FI, consider making attribute values from Strings to CharSequences.
aoqi@0: *
aoqi@0: * @author Kohsuke Kawaguchi
aoqi@0: */
aoqi@0: public interface XmlOutput {
aoqi@0: //
aoqi@0: //
aoqi@0: // Contracts
aoqi@0: //
aoqi@0: //
aoqi@0: /**
aoqi@0: * Called at the very beginning.
aoqi@0: *
aoqi@0: * @param serializer
aoqi@0: * the {@link XMLSerializer} that coordinates this whole marshalling episode.
aoqi@0: * @param fragment
aoqi@0: * true if we are marshalling a fragment.
aoqi@0: */
aoqi@0: public void startDocument(XMLSerializer serializer, boolean fragment, int[] nsUriIndex2prefixIndex, NamespaceContextImpl nsContext) throws IOException, SAXException, XMLStreamException;
aoqi@0:
aoqi@0: /**
aoqi@0: * Called at the very end. This is the last method to be invoked.
aoqi@0: *
aoqi@0: * @param fragment
aoqi@0: * false if we are writing the whole document.
aoqi@0: */
aoqi@0: public void endDocument(boolean fragment) throws IOException, SAXException, XMLStreamException;
aoqi@0:
aoqi@0: /**
aoqi@0: * Writes a start tag.
aoqi@0: *
aoqi@0: * aoqi@0: * At this point {@link NamespaceContextImpl} holds namespace declarations needed for this aoqi@0: * new element. aoqi@0: * aoqi@0: *
aoqi@0: * This method is used for writing tags that are indexed. aoqi@0: */ aoqi@0: public void beginStartTag(Name name) throws IOException, XMLStreamException; aoqi@0: aoqi@0: public void beginStartTag(int prefix, String localName) throws IOException, XMLStreamException; aoqi@0: aoqi@0: public void attribute( Name name, String value ) throws IOException, XMLStreamException; aoqi@0: aoqi@0: /** aoqi@0: * @param prefix aoqi@0: * -1 if this attribute does not have a prefix aoqi@0: * (this handling differs from that of elements.) aoqi@0: */ aoqi@0: public void attribute( int prefix, String localName, String value ) throws IOException, XMLStreamException; aoqi@0: aoqi@0: public void endStartTag() throws IOException, SAXException; aoqi@0: aoqi@0: public void endTag(Name name) throws IOException, SAXException, XMLStreamException; aoqi@0: aoqi@0: public void endTag(int prefix, String localName) throws IOException, SAXException, XMLStreamException; aoqi@0: aoqi@0: /** aoqi@0: * Writes XML text with character escaping, if necessary. aoqi@0: * aoqi@0: * @param value aoqi@0: * this string can contain characters that might need escaping aoqi@0: * (such as '&' or '>') aoqi@0: * @param needsSeparatingWhitespace aoqi@0: */ aoqi@0: public void text( String value, boolean needsSeparatingWhitespace ) throws IOException, SAXException, XMLStreamException; aoqi@0: aoqi@0: /** aoqi@0: * Writes XML text with character escaping, if necessary. aoqi@0: * aoqi@0: * @param value aoqi@0: * this string can contain characters that might need escaping aoqi@0: * (such as '&' or '>') aoqi@0: * @param needsSeparatingWhitespace aoqi@0: */ aoqi@0: public void text( Pcdata value, boolean needsSeparatingWhitespace ) throws IOException, SAXException, XMLStreamException; aoqi@0: }