1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2005-2017 Oracle and/or its affiliates. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can
10 * obtain a copy of the License at
11 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
12 * or LICENSE.txt. See the License for the specific
13 * language governing permissions and limitations under the License.
14 *
15 * When distributing the software, include this License Header Notice in each
16 * file and include the License file at LICENSE.txt.
17 *
18 * GPL Classpath Exception:
19 * Oracle designates this particular file as subject to the "Classpath"
20 * exception as provided by Oracle in the GPL Version 2 section of the License
21 * file that accompanied this code.
22 *
23 * Modifications:
24 * If applicable, add the following below the License Header, with the fields
25 * enclosed by brackets [] replaced by your own identifying information:
26 * "Portions Copyright [year] [name of copyright owner]"
27 *
28 * Contributor(s):
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41 package javax.xml.bind.annotation;
42
43 import org.w3c.dom.Document;
44 import org.w3c.dom.DocumentFragment;
45 import org.w3c.dom.Element;
46 import org.w3c.dom.Node;
47
48 import javax.xml.bind.ValidationEventHandler;
49 import javax.xml.parsers.DocumentBuilder;
50 import javax.xml.transform.Source;
51 import javax.xml.transform.dom.DOMResult;
52 import javax.xml.transform.dom.DOMSource;
53
54 /**
55 * {@link DomHandler} implementation for W3C DOM (<code>org.w3c.dom</code> package.)
56 *
57 * @author Kohsuke Kawaguchi
58 * @since 1.6, JAXB 2.0
59 */
60 public class W3CDomHandler implements DomHandler<Element,DOMResult> {
61
62 private DocumentBuilder builder;
63
64 /**
65 * Default constructor.
66 *
67 * It is up to a JAXB provider to decide which DOM implementation
68 * to use or how that is configured.
69 */
70 public W3CDomHandler() {
71 this.builder = null;
72 }
73
74 /**
75 * Constructor that allows applications to specify which DOM implementation
76 * to be used.
77 *
78 * @param builder
79 * must not be null. JAXB uses this {@link DocumentBuilder} to create
80 * a new element.
81 */
82 public W3CDomHandler(DocumentBuilder builder) {
83 if(builder==null)
84 throw new IllegalArgumentException();
85 this.builder = builder;
86 }
87
88 public DocumentBuilder getBuilder() {
89 return builder;
90 }
91
92 public void setBuilder(DocumentBuilder builder) {
93 this.builder = builder;
94 }
95
96 public DOMResult createUnmarshaller(ValidationEventHandler errorHandler) {
97 if(builder==null)
98 return new DOMResult();
99 else
100 return new DOMResult(builder.newDocument());
101 }
102
103 public Element getElement(DOMResult r) {
104 // JAXP spec is ambiguous about what really happens in this case,
105 // so work defensively
106 Node n = r.getNode();
107 if( n instanceof Document ) {
108 return ((Document)n).getDocumentElement();
109 }
110 if( n instanceof Element )
111 return (Element)n;
112 if( n instanceof DocumentFragment )
113 return (Element)n.getChildNodes().item(0);
114
115 // if the result object contains something strange,
116 // it is not a user problem, but it is a JAXB provider's problem.
117 // That's why we throw a runtime exception.
118 throw new IllegalStateException(n.toString());
119 }
120
121 public Source marshal(Element element, ValidationEventHandler errorHandler) {
122 return new DOMSource(element);
123 }
124 }
125