org.jvnet.jaxbcommons.runtime.XMLSerializer Maven / Gradle / Ivy
//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v1.0.6-01/24/2006 06:15 PM(kohsuke)-fcs
// See http://java.sun.com/xml/jaxb
// Any modifications to this file will be lost upon recompilation of the source schema.
// Generated on: 2006.07.10 at 02:12:40 PM CEST
//
package org.jvnet.jaxbcommons.runtime;
import javax.xml.bind.ValidationEvent;
import org.xml.sax.SAXException;
import com.sun.xml.bind.JAXBObject;
import com.sun.xml.bind.marshaller.IdentifiableObject;
import com.sun.xml.bind.serializer.AbortSerializationException;
/**
* Receives XML serialization event
*
*
* This object coordinates the overall marshalling efforts across different
* content-tree objects and different target formats.
*
*
* The following CFG gives the proper sequence of method invocation.
*
*
* MARSHALLING := ELEMENT
* ELEMENT := "startElement" NSDECL* "endNamespaceDecls"
* ATTRIBUTE* "endAttributes" BODY "endElement"
*
* NSDECL := "declareNamespace"
*
* ATTRIBUTE := "startAttribute" ATTVALUES "endAttribute"
* ATTVALUES := "text"*
*
*
* BODY := ( "text" | ELEMENT )*
*
*
*
* A marshalling of one element consists of two stages. The first stage is
* for marshalling attributes and collecting namespace declarations.
* The second stage is for marshalling characters/child elements of that element.
*
*
* Observe that multiple invocation of "text" is allowed.
*
*
* Also observe that the namespace declarations are allowed only between
* "startElement" and "endAttributes".
*
*
* @author Kohsuke Kawaguchi
*/
public interface XMLSerializer
{
/**
* Errors detected by the XMLSerializable should be either thrown
* as {@link SAXException} or reported through this method.
*
* The callee should report an error to the client application
* and
*/
void reportError( ValidationEvent e ) throws AbortSerializationException;
/**
* Starts marshalling of an element.
* Calling this method will push the internal state into the
* internal stack.
*/
void startElement( String uri, String local ) throws SAXException;
/**
* Switches to the mode to marshal attribute values.
* This method has to be called after the 1st pass is completed.
*/
void endNamespaceDecls() throws SAXException;
/**
* Switches to the mode to marshal child texts/elements.
* This method has to be called after the 2nd pass is completed.
*/
void endAttributes() throws SAXException;
/**
* Ends marshalling of an element.
* Pops the internal stack.
*/
void endElement() throws SAXException;
/**
* Marshalls text.
*
*
* This method can be called (i) after the startAttribute method
* and (ii) before the endAttribute method, to marshal attribute values.
* If the method is called more than once, those texts are considered
* as separated by whitespaces. For example,
*
*
* c.startAttribute();
* c.text("abc");
* c.text("def");
* c.endAttribute("","foo");
*
*
* will generate foo="abc def".
*
*
* Similarly, this method can be called after the endAttributes
* method to marshal texts inside elements. The same rule about
* multiple invokations apply to this case, too. For example,
*
*
* c.startElement("","foo");
* c.endNamespaceDecls();
* c.endAttributes();
* c.text("abc");
* c.text("def");
* c.startElement("","bar");
* c.endAttributes();
* c.endElement();
* c.text("ghi");
* c.endElement();
*
*
* will generate <foo>abc def<bar/>ghi</foo>.
*/
void text( String text, String fieldName ) throws SAXException;
/**
* Starts marshalling of an attribute.
*
* The marshalling of an attribute will be done by
*
* - call the startAttribute method
*
- call the text method (several times if necessary)
*
- call the endAttribute method
*
*
* No two attributes can be marshalled at the same time.
* Note that the whole attribute marshalling must be happened
* after the startElement method and before the endAttributes method.
*/
void startAttribute( String uri, String local ) throws SAXException;
void endAttribute() throws SAXException;
/**
* Obtains a namespace context object, which is used to
* declare/obtain namespace bindings.
*/
NamespaceContext2 getNamespaceContext();
/**
* Notifies the serializer that an ID value has just marshalled.
*
* The serializer may or may not check the consistency of ID/IDREFs
* and may throw a SAXException.
*
* @param owner
* JAXB content object that posesses the ID.
* @param value
* The value of the ID.
*
* @return
* Return the value parameter without any modification,
* so that the invocation of this method can be done transparently
* by a transducer.
*/
String onID( IdentifiableObject owner, String value ) throws SAXException;
/**
* Notifies the serializer that an IDREF value has just marshalled.
*
* The serializer may or may not check the consistency of ID/IDREFs
* and may throw a SAXException.
*
* @return
* Return the value parameter without any modification.
* so that the invocation of this method can be done transparently
* by a transducer.
*/
String onIDREF( IdentifiableObject obj ) throws SAXException;
// I suppose we don't want to use SAXException. -kk
// those method signatures are purposely made to JAXBContext, not
// XMLSerializable, to avoid N^2 proxy overhead.
/**
* This method is called when an JAXBObject object is found
* while the marshaller is in the "element" mode (i.e. marshalling
* a content model of an element)
*
* @param fieldName
* property name of the parent objeect from which 'o' comes.
* Used as a part of the error message in case anything goes wrong
* with 'o'.
*/
void childAsBody( JAXBObject o, String fieldName ) throws SAXException;
/**
* This method is called when an JAXBObject object is found
* while the marshaller is in the "attribute" mode (i.e. marshalling
* attributes of an element)
*
* @param fieldName
* property name of the parent objeect from which 'o' comes.
* Used as a part of the error message in case anything goes wrong
* with 'o'.
*/
void childAsAttributes( JAXBObject o, String fieldName ) throws SAXException;
/**
* This method is called when an JAXBObject object is found
* while the marshaller is in the "URI" mode.
*
* @param fieldName
* property name of the parent objeect from which 'o' comes.
* Used as a part of the error message in case anything goes wrong
* with 'o'.
*/
void childAsURIs( JAXBObject o, String fieldName ) throws SAXException;
}