-
Notifications
You must be signed in to change notification settings - Fork 3
/
JDOMStreamWriter.java
713 lines (618 loc) · 22.2 KB
/
JDOMStreamWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
/*--
Copyright (C) 2000-2012 Jason Hunter & Brett McLaughlin.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions, and the disclaimer that follows
these conditions in the documentation and/or other materials
provided with the distribution.
3. The name "JDOM" must not be used to endorse or promote products
derived from this software without prior written permission. For
written permission, please contact <request_AT_jdom_DOT_org>.
4. Products derived from this software may not be called "JDOM", nor
may "JDOM" appear in their name, without prior written permission
from the JDOM Project Management <request_AT_jdom_DOT_org>.
In addition, we request (but do not require) that you include in the
end-user documentation provided with the redistribution and/or in the
software itself an acknowledgement equivalent to the following:
"This product includes software developed by the
JDOM Project (http://www.jdom.org/)."
Alternatively, the acknowledgment may be graphical using the logos
available at http://www.jdom.org/images/logos.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
This software consists of voluntary contributions made by many
individuals on behalf of the JDOM Project and was originally
created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
on the JDOM Project, please see <http://www.jdom.org/>.
*/
package org.jdom2.jaxb;
import java.util.ArrayList;
import java.util.LinkedList;
import javax.xml.namespace.NamespaceContext;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.jdom2.DefaultJDOMFactory;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMConstants;
import org.jdom2.JDOMFactory;
import org.jdom2.Namespace;
import org.jdom2.Parent;
import org.jdom2.Text;
import org.jdom2.jaxb.NamespaceStack;
/**
* An {@link XMLStreamWriter} implementation that writes XML data to a new JDOM
* {@link Document}. The document can be retrieved using {@link #getDocument() }.
*
* @author gordon burgett https://github.com/gburgett
*/
public class JDOMStreamWriter implements XMLStreamWriter {
private static final DefaultJDOMFactory DEFFAC = new DefaultJDOMFactory();
// The optional global namespace context for namespace bindings.
private NamespaceContext globalcontext = null;
// The active Element NamespaceStack of actual used Namespaces.
private NamespaceStack usednsstack = new NamespaceStack();
// The stack of namespace bindings which may not necessarily be used in an element
private NamespaceStack boundstack = new NamespaceStack();
// The namespaces pending in the current Element that need to be actively bound.
private LinkedList<Namespace> pendingns = new LinkedList<Namespace>();
// Are we throwing exceptions for namespace problems, or fixing them.
private final boolean repairnamespace;
private Document document = null;
private boolean done = false;
private Parent parent = null;
private Element activeelement = null;
private boolean isempty = false;
private Text activetext = null;
private int genprefix = 0;
private final JDOMFactory factory;
/**
* Create a JDOMStreamWriter with the default JDOMFactory for creating JDOM
* Content.
*/
public JDOMStreamWriter() {
this(DEFFAC, true);
}
/**
* Create a JDOMStreamWriter with the specified JDOMFactory for creating
* JDOM Content.
*
* @param fac
* The JDOMFactory to use.
* @param repairnamespace
* If true, then repair namespace errors.
*/
public JDOMStreamWriter(final JDOMFactory fac, final boolean repairnamespace) {
this.factory = fac;
this.repairnamespace = repairnamespace;
// create an empty level in the namespace stack.
boundstack.push(new Namespace[0]);
}
/**
* Gets the {@link Document} that was created by this writer. Only available
* after {@link #writeEndDocument() } has been called, and before the Writer
* is closed.
*
* @return The created {@link Document}
*/
public Document getDocument() {
if (done && document != null) {
return document;
}
if (done) {
throw new IllegalStateException("Writer is closed");
}
throw new IllegalStateException(
"Cannot get Document until writer has ended the document");
}
@Override
public void writeStartDocument() throws XMLStreamException {
this.writeStartDocument(null, null);
}
@Override
public void writeStartDocument(final String version)
throws XMLStreamException {
this.writeStartDocument(null, version);
}
@Override
public void writeStartDocument(final String encoding, final String version)
throws XMLStreamException {
// JDOM has no support for XML Version specification/handling
// ignore version.
if (done || document != null) {
throw new IllegalStateException(
"Cannot write start document twice.");
}
document = factory.document(null);
parent = document;
if (encoding != null && !"".equals(encoding))
this.document.setProperty("ENCODING", encoding);
activeelement = null;
}
@Override
public void setNamespaceContext(final NamespaceContext context)
throws XMLStreamException {
if (document == null || document.hasRootElement()) {
throw new XMLStreamException("Can only set the NamespaceContext at the Document start");
}
globalcontext = context;
}
@Override
public String getPrefix(final String uri) throws XMLStreamException {
if (document == null) {
return null;
}
final Namespace n = boundstack.getFirstNamespaceForURI(uri);
if (n != null) {
return n.getPrefix();
}
if (globalcontext != null) {
return globalcontext.getPrefix(uri);
}
return null;
}
@Override
public void setPrefix(final String prefix, final String uri)
throws XMLStreamException {
if (prefix == null) {
throw new IllegalArgumentException("prefix may not be null");
}
if (document == null || done) {
throw new IllegalStateException(
"Attempt to set prefix at an illegal stream state.");
}
/*
* Setting a prefix (or a default namespace) is not the same as writing the namespace.
* It is only a 'binding' of the URI to a prefix. This binding is used for two purposes:
* - any prefixes bound in here are used if a prefix is not specified in the startelement
* - if repairnamespace is false, then all used namespaces must first be pre-bound
* This method is specified to allow a null URI. This makes no sense unless the prefix is ""
* and will cause a Namespace exception if the prefix is not "".
*/
final Namespace ns = Namespace.getNamespace(prefix, uri);
if (!boundstack.isInScope(ns)) {
final ArrayList<Namespace> al = new ArrayList<Namespace>();
for (Namespace n : boundstack) {
if (n.getPrefix().equals(prefix)) {
// do not rebind the same prefix with the old URI.
continue;
}
al.add(n);
}
// bind the new URI to the prefix.
al.add(ns);
// kill the previous bindings.
boundstack.pop();
// reset the binding.
boundstack.push(al);
}
}
@Override
public void setDefaultNamespace(final String uri) throws XMLStreamException {
setPrefix(JDOMConstants.NS_PREFIX_DEFAULT, uri);
}
@Override
public void writeDTD(final String dtd) throws XMLStreamException {
// FIXME to do ... ?
throw new UnsupportedOperationException("not supported yet");
}
@Override
public void writeStartElement(final String localName) throws XMLStreamException {
writeStartElement("", localName);
}
@Override
public void writeStartElement(final String namespaceURI, final String localName)
throws XMLStreamException {
if (namespaceURI == null) {
throw new XMLStreamException("Cannot have a null namespaceURI");
}
if (localName == null) {
throw new XMLStreamException("Cannot have a null localname");
}
this.buildElement("", localName, namespaceURI, false, false);
}
@Override
public void writeStartElement(final String prefix, final String localName,
final String namespaceURI) throws XMLStreamException {
if (prefix == null) {
throw new XMLStreamException("Cannot have a null prefix");
}
if (localName == null) {
throw new XMLStreamException("Cannot have a null localName");
}
if (namespaceURI == null) {
throw new XMLStreamException("Cannot have a null namespaceURI");
}
buildElement(prefix, localName, namespaceURI, true, false);
}
@Override
public void writeEmptyElement(final String localName)
throws XMLStreamException {
if (localName == null) {
throw new XMLStreamException("Cannot have a null localname");
}
this.buildElement("", localName, "", false, true);
}
@Override
public void writeEmptyElement(final String namespaceURI,
final String localName) throws XMLStreamException {
if (namespaceURI == null) {
throw new XMLStreamException("Cannot have a null namespaceURI");
}
if (localName == null) {
throw new XMLStreamException("Cannot have a null localname");
}
this.buildElement("", localName, namespaceURI, false, true);
}
@Override
public void writeEmptyElement(final String prefix, final String localName,
final String namespaceURI) throws XMLStreamException {
if (prefix == null) {
throw new XMLStreamException("Cannot have a null prefix");
}
if (localName == null) {
throw new XMLStreamException("Cannot have a null localname");
}
if (namespaceURI == null) {
throw new XMLStreamException("Cannot have a null namespaceURI");
}
buildElement(prefix, localName, namespaceURI, true, true);
}
@Override
public void writeDefaultNamespace(final String namespaceURI)
throws XMLStreamException {
this.writeNamespace("", namespaceURI);
}
@Override
public void writeNamespace(final String prefix, final String namespaceURI)
throws XMLStreamException {
if (activeelement == null) {
throw new IllegalStateException("Can only write a Namespace after starting an Element" +
" and before adding content to that Element.");
}
if (prefix == null || JDOMConstants.NS_PREFIX_XMLNS.equals(prefix)) {
// recurse with the "" prefix.
writeNamespace("", namespaceURI);
} else {
pendingns.add(Namespace.getNamespace(prefix, namespaceURI));
}
}
@Override
public void writeAttribute(final String localName, final String value)
throws XMLStreamException {
buildAttribute("", "", localName, value, false);
}
@Override
public void writeAttribute(final String namespaceURI,
final String localName, final String value)
throws XMLStreamException {
buildAttribute("", namespaceURI == null ? "" : namespaceURI, localName, value, false);
}
@Override
public void writeAttribute(final String prefix, final String namespaceURI,
final String localName, final String value)
throws XMLStreamException {
buildAttribute(prefix == null ? "" : prefix, namespaceURI == null ? "" : namespaceURI, localName, value, true);
}
@Override
public void writeComment(final String data) throws XMLStreamException {
if (document == null || done) {
throw new XMLStreamException("Can only add a Comment to the Document or an Element.");
}
flushActiveElement();
flushActiveText();
factory.addContent(parent, factory.comment(data));
}
@Override
public void writeProcessingInstruction(final String target)
throws XMLStreamException {
if (document == null || done) {
throw new XMLStreamException("Can only add a ProcessingInstruction to the Document or an Element.");
}
flushActiveElement();
flushActiveText();
factory.addContent(parent, factory.processingInstruction(target));
}
@Override
public void writeProcessingInstruction(final String target,
final String data) throws XMLStreamException {
if (document == null || done) {
throw new XMLStreamException("Can only add a ProcessingInstruction to the Document or an Element.");
}
flushActiveElement();
flushActiveText();
factory.addContent(parent, factory.processingInstruction(target, data));
}
@Override
public void writeCData(final String data) throws XMLStreamException {
if (!(parent instanceof Element)) {
throw new XMLStreamException("Can only writeCDATA() inside an Element.");
}
flushActiveElement();
flushActiveText();
factory.addContent(parent, factory.cdata(data));
}
@Override
public void writeEntityRef(final String name) throws XMLStreamException {
if (!(parent instanceof Element)) {
throw new XMLStreamException("Can only writeEntityRef() inside an Element.");
}
flushActiveElement();
flushActiveText();
factory.addContent(parent, factory.entityRef(name));
}
@Override
public void writeCharacters(final String chars) throws XMLStreamException {
if (document == null || done) {
throw new XMLStreamException("Unable to add Characters at this point in the stream.");
}
flushActiveElement();
if (chars == null) {
return;
}
if (parent instanceof Element) {
if (activetext != null) {
activetext.append(chars);
} else {
activetext = factory.text(chars);
factory.addContent(parent, activetext);
}
}
// ignore case where parent is Document.
}
@Override
public void writeCharacters(final char[] chars, final int start,
final int len) throws XMLStreamException {
writeCharacters(new String(chars, start, len));
}
@Override
public void writeEndElement() throws XMLStreamException {
if (!(parent instanceof Element)) {
throw new XMLStreamException("Cannot end an Element unless you are in an Element.");
}
flushActiveElement();
flushActiveText();
usednsstack.pop();
boundstack.pop();
boundstack.pop();
boundstack.pop();
parent = parent.getParent();
}
@Override
public void writeEndDocument() throws XMLStreamException {
// flush may change state if isempty root element
if (document == null || done || parent instanceof Element) {
throw new IllegalStateException(
"Cannot write end document before writing the end of root element");
}
flushActiveElement();
done = true;
}
@Override
public void close() throws XMLStreamException {
this.document = null;
this.parent = null;
activeelement = null;
activetext = null;
boundstack = null;
usednsstack = null;
done = true;
}
@Override
public void flush() throws XMLStreamException {
// flush does nothing.
}
@Override
public NamespaceContext getNamespaceContext() {
if (document == null) {
return new JDOMNamespaceContext(new Namespace[0]);
}
return new JDOMNamespaceContext(boundstack.getScope());
}
@Override
public Object getProperty(String name) throws IllegalArgumentException {
throw new UnsupportedOperationException("Not supported yet.");
}
// *****************************
// Private methods.
// *****************************
/**
* Simple method that implements the empty-element logic without the spec-required
* null-check logic
* @param prefix The namespace prefix (may be null).
* @param localName The Element tag
* @param namespaceURI The namespace URI (may be null).
* @param empty Is this an Empty element (expecting children?)
* @throws XMLStreamException If the stream is not in an appropriate state for a new Element.
*/
private final void buildElement(final String prefix, final String localName,
final String namespaceURI, final boolean withpfx, boolean empty) throws XMLStreamException {
if (document == null || done) {
throw new XMLStreamException(
"Cannot write new element when in current state.");
}
if (parent == document && document.hasRootElement()) {
throw new XMLStreamException(
"Document can have only one root Element.");
}
flushActiveElement();
flushActiveText();
// create an element-specific namespace binding layer.
boundstack.push();
final Namespace ns = resolveElementNamespace(prefix, namespaceURI, withpfx);
final Element e = factory.element(localName, ns);
factory.addContent(parent, e);
activeelement = e;
if (empty) {
isempty = true;
} else {
isempty = false;
parent = e;
}
}
private Namespace resolveElementNamespace(String prefix, String namespaceURI,
boolean withpfx) throws XMLStreamException {
if ("".equals(namespaceURI)) {
final Namespace defns = boundstack.getNamespaceForPrefix("");
if(Namespace.NO_NAMESPACE != defns) {
// inconsistency in XMLStreamWriter specification....
// In theory the repairing code should create a generated prefic for unbound
// namespace URI, but you can't create a prefixed ""-URI namespace.
throw new XMLStreamException("This attempt to use the empty URI \"\" as an " +
"Element Namespace is illegal because the default Namespace is already " +
"bound to the URI '" + defns.getURI() + "'. You must call " +
"setPrefix(\"\", \"\") prior to this call.");
}
}
final Namespace ns = Namespace.getNamespace(prefix, namespaceURI);
if (withpfx) {
final Namespace bnd = boundstack.getNamespaceForPrefix(prefix);
if (bnd == null || bnd == ns) {
// no existing binding for prefix, or same binding.
return ns;
}
// prefix is bound to a different URI
if (repairnamespace) {
return Namespace.getNamespace(generatePrefix(), namespaceURI);
}
throw new XMLStreamException("Namespace prefix " + prefix +
" in this scope is bound to a different URI '" + bnd.getURI() +
"' (repairing not set for this XMLStreamWriter).");
}
// see if the default namespace is bound correctly...
if (boundstack.getNamespaceForPrefix("") == ns) {
return ns;
}
// nope, so see if there's any other bound namespace with the same URI.
final Namespace bound = boundstack.getFirstNamespaceForURI(namespaceURI);
if (bound != null) {
return bound;
}
// there are no existing bindings with the specified URI.
if (repairnamespace) {
return Namespace.getNamespace(generatePrefix(), namespaceURI);
}
throw new XMLStreamException("Namespace URI " + namespaceURI +
" is not bound in this scope (repairing not set for this XMLStreamWriter).");
}
private Namespace resolveAttributeNamespace(String prefix, String namespaceURI,
boolean withpfx) throws XMLStreamException {
final Namespace ns = Namespace.getNamespace(prefix, namespaceURI);
if (ns == Namespace.NO_NAMESPACE) {
return ns;
}
if (withpfx && !"".equals(prefix)) {
Namespace bnd = boundstack.getNamespaceForPrefix(prefix);
if (bnd == null || bnd == ns) {
// no existing binding for prefix, or same binding.
return ns;
}
// prefix is bound to a different URI
if (repairnamespace) {
final Namespace gen = Namespace.getNamespace(generatePrefix(), namespaceURI);
setPrefix(gen.getPrefix(), gen.getURI());
return gen;
}
throw new XMLStreamException("Namespace prefix " + prefix +
" in this scope is bound to a different URI '" + bnd.getURI() +
"' (repairing not set for this XMLStreamWriter).");
}
// see if there's any other bound namespace with the same URI.
final Namespace[] bound = boundstack.getAllNamespacesForURI(namespaceURI);
for (Namespace b : bound) {
if (!"".equals(b.getPrefix())) {
// use an existing prefixed Namespace binding.
// good for both repairing and non-repairing
return b;
}
}
// there are no existing prefixed bindings with the specified URI.
if (repairnamespace || bound.length > 0) {
return Namespace.getNamespace(generatePrefix(), namespaceURI);
}
throw new XMLStreamException("Namespace URI " + namespaceURI +
" is not bound in this attribute scope (repairing not set for this XMLStreamWriter).");
}
private String generatePrefix() {
String pfx = String.format("ns%03d", ++genprefix);
while (boundstack.getNamespaceForPrefix(pfx) != null) {
pfx = String.format("ns%03d", ++genprefix);
}
return pfx;
}
private final void buildAttribute(final String prefix,
final String namespaceURI, final String localName,
final String value, final boolean withpfx) throws XMLStreamException {
if (!(parent instanceof Element)) {
throw new IllegalStateException(
"Cannot write attribute unless inside an Element.");
}
if (localName == null) {
throw new XMLStreamException("localName is not allowed to be null");
}
if (value == null) {
throw new XMLStreamException("value is not allowed to be null");
}
if (activeelement == null) {
throw new IllegalStateException("Cannot add Attributes to an Element after other content was added.");
}
Namespace ns = resolveAttributeNamespace(prefix, namespaceURI, withpfx);
factory.setAttribute(activeelement, factory.attribute(localName, value, ns));
}
private final void flushActiveElement() {
if (activeelement != null) {
/*
* Add any written namespaces to the element as declared namespaces
* unless they are implied namespaces used by attributes, or something.
* If this Element is expecting content (it's not empty) then we also
* push the modified Element on to the Namespace stack.
*/
boolean mod = false;
usednsstack.push(activeelement);
for (Namespace ns : pendingns) {
if (!usednsstack.isInScope(ns)) {
activeelement.addNamespaceDeclaration(ns);
mod = true;
}
}
pendingns.clear();
if (mod) {
usednsstack.pop();
if (isempty) {
boundstack.pop();
activeelement = null;
return;
}
// reload the stack with the additional namespaces.
usednsstack.push(activeelement);
}
if (isempty) {
boundstack.pop();
activeelement = null;
return;
}
boundstack.push(activeelement);
boundstack.push();
activeelement = null;
}
}
private final void flushActiveText() {
activetext = null;
}
}