001: /*
002: * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: *
023: * Free Software Foundation, Inc.
024: * 59 Temple Place, Suite 330
025: * Boston, MA 02111-1307 USA
026: *
027: * @author Scott Ferguson
028: */
029:
030: package javax.xml.bind;
031:
032: import org.w3c.dom.Node;
033: import org.xml.sax.ContentHandler;
034:
035: import javax.xml.bind.annotation.adapters.XmlAdapter;
036: import javax.xml.bind.attachment.AttachmentMarshaller;
037: import javax.xml.stream.XMLEventWriter;
038: import javax.xml.stream.XMLStreamWriter;
039: import javax.xml.transform.Result;
040: import javax.xml.validation.Schema;
041: import java.io.*;
042:
043: public interface Marshaller {
044:
045: static final String JAXB_ENCODING = "jaxb.encoding";
046:
047: static final String JAXB_FORMATTED_OUTPUT = "jaxb.formatted.output";
048:
049: static final String JAXB_FRAGMENT = "jaxb.fragment";
050:
051: static final String JAXB_NO_NAMESPACE_SCHEMA_LOCATION = "jaxb.noNamespaceSchemaLocation";
052:
053: static final String JAXB_SCHEMA_LOCATION = "jaxb.schemaLocation";
054:
055: <A extends XmlAdapter> A getAdapter(Class<A> type);
056:
057: AttachmentMarshaller getAttachmentMarshaller();
058:
059: ValidationEventHandler getEventHandler() throws JAXBException;
060:
061: Listener getListener();
062:
063: Node getNode(Object contentTree) throws JAXBException;
064:
065: Object getProperty(String name) throws PropertyException;
066:
067: Schema getSchema();
068:
069: void marshal(Object jaxbElement, ContentHandler handler)
070: throws JAXBException;
071:
072: void marshal(Object jaxbElement, Node node) throws JAXBException;
073:
074: void marshal(Object jaxbElement, OutputStream os)
075: throws JAXBException;
076:
077: void marshal(Object jaxbElement, Result result)
078: throws JAXBException;
079:
080: void marshal(Object jaxbElement, Writer writer)
081: throws JAXBException;
082:
083: /**
084: * @since JAXB 2.1
085: */
086: void marshal(Object jaxbElement, File output) throws JAXBException;
087:
088: void marshal(Object jaxbElement, XMLEventWriter writer)
089: throws JAXBException;
090:
091: void marshal(Object jaxbElement, XMLStreamWriter writer)
092: throws JAXBException;
093:
094: <A extends XmlAdapter> void setAdapter(Class<A> type, A adapter);
095:
096: void setAdapter(XmlAdapter adapter);
097:
098: void setAttachmentMarshaller(AttachmentMarshaller am);
099:
100: void setEventHandler(ValidationEventHandler handler)
101: throws JAXBException;
102:
103: void setListener(Listener listener);
104:
105: void setProperty(String name, Object value)
106: throws PropertyException;
107:
108: void setSchema(Schema schema);
109:
110: public static abstract class Listener {
111:
112: public Listener() {
113: }
114:
115: public void afterMarshal(Object source) {
116: }
117:
118: public void beforeMarshal(Object source) {
119: }
120:
121: }
122: }
|