-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathXMLElement.java
More file actions
2570 lines (2404 loc) · 87.2 KB
/
XMLElement.java
File metadata and controls
2570 lines (2404 loc) · 87.2 KB
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* XMLElement.java
*
* $Revision: 1.4 $
* $Date: 2002/03/24 10:27:59 $
* $Name: RELEASE_2_2_1 $
*
* This file is part of NanoXML 2 Lite.
* Copyright (C) 2000-2002 Marc De Scheemaecker, All Rights Reserved.
*
* This software is provided 'as-is', without any express or implied warranty.
* In no event will the authors be held liable for any damages arising from the
* use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software in
* a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*****************************************************************************/
package nanoxml;
import java.io.ByteArrayOutputStream;
import java.io.CharArrayReader;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.StringReader;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* XMLElement is a representation of an XML object. The object is able to parse
* XML code.
* <P><DL>
* <DT><B>Parsing XML Data</B></DT>
* <DD>
* You can parse XML data using the following code:
* <UL><CODE>
* XMLElement xml = new XMLElement();<BR>
* FileReader reader = new FileReader("filename.xml");<BR>
* xml.parseFromReader(reader);
* </CODE></UL></DD></DL>
* <DL><DT><B>Retrieving Attributes</B></DT>
* <DD>
* You can enumerate the attributes of an element using the method
* {@link #enumerateAttributeNames() enumerateAttributeNames}.
* The attribute values can be retrieved using the method
* {@link #getStringAttribute(java.lang.String) getStringAttribute}.
* The following example shows how to list the attributes of an element:
* <UL><CODE>
* XMLElement element = ...;<BR>
* Enumeration enum = element.getAttributeNames();<BR>
* while (enum.hasMoreElements()) {<BR>
* String key = (String) enum.nextElement();<BR>
* String value = element.getStringAttribute(key);<BR>
* System.out.println(key + " = " + value);<BR>
* }
* </CODE></UL></DD></DL>
* <DL><DT><B>Retrieving Child Elements</B></DT>
* <DD>
* You can enumerate the children of an element using
* {@link #enumerateChildren() enumerateChildren}.
* The number of child elements can be retrieved using
* {@link #countChildren() countChildren}.
* </DD></DL>
* <DL><DT><B>Elements Containing Character Data</B></DT>
* <DD>
* If an elements contains character data, like in the following example:
* <UL><CODE>
* <title>The Title</title>
* </CODE></UL>
* you can retrieve that data using the method
* {@link #getContent() getContent}.
* </DD></DL>
* <DL><DT><B>Subclassing XMLElement</B></DT>
* <DD>
* When subclassing XMLElement, you need to override the method
* {@link #createAnotherElement() createAnotherElement}
* which has to return a new copy of the receiver.
* </DD></DL>
* <P>
*
* @see nanoxml.XMLParseException
*
* @author Marc De Scheemaecker
* <<A href="mailto:cyberelf@mac.com">cyberelf@mac.com</A>>
* @version $Name: RELEASE_2_2_1 $, $Revision: 1.4 $
*/
public class XMLElement
{
/**
* Major version of NanoXML. Classes with the same major and minor
* version are binary compatible. Classes with the same major version
* are source compatible. If the major version is different, you may
* need to modify the client source code.
*
* @see nanoxml.XMLElement#NANOXML_MINOR_VERSION
*/
public static final int NANOXML_MAJOR_VERSION = 3;
/**
* Minor version of NanoXML. Classes with the same major and minor
* version are binary compatible. Classes with the same major version
* are source compatible. If the major version is different, you may
* need to modify the client source code.
*
* @see nanoxml.XMLElement#NANOXML_MAJOR_VERSION
*/
public static final int NANOXML_MINOR_VERSION = 0;
/**
* The attributes given to the element.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>The field can be empty.
* <li>The field is never <code>null</code>.
* <li>The keys and the values are strings.
* </ul></dd></dl>
*/
private Map<String, String> attributes;
/**
* Child elements of the element.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>The field can be empty.
* <li>The field is never <code>null</code>.
* <li>The elements are instances of <code>XMLElement</code>
* or a subclass of <code>XMLElement</code>.
* </ul></dd></dl>
*/
private List<XMLElement> children;
/**
* The name of the element.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>The field is <code>null</code> iff the element is not
* initialized by either parse or setName.
* <li>If the field is not <code>null</code>, it's not empty.
* <li>If the field is not <code>null</code>, it contains a valid
* XML identifier.
* </ul></dd></dl>
*/
private String name;
/**
* The #PCDATA content of the object.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>The field is <code>null</code> iff the element is not a
* #PCDATA element.
* <li>The field can be any string, including the empty string.
* </ul></dd></dl>
*/
private String contents;
/**
* Conversion table for &...; entities. The keys are the entity names
* without the & and ; delimiters.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>The field is never <code>null</code>.
* <li>The field always contains the following associations:
* "lt" => "<", "gt" => ">",
* "quot" => "\"", "apos" => "'",
* "amp" => "&"
* <li>The keys are strings
* <li>The values are char arrays
* </ul></dd></dl>
*/
private Map<String, char[]> entities;
/**
* The line number where the element starts.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li><code>lineNr > 0</code>
* </ul></dd></dl>
*/
private int lineNr;
/**
* <code>true</code> if the case of the element and attribute names
* are case insensitive.
*/
private boolean ignoreCase;
/**
* <code>true</code> if the leading and trailing whitespace of #PCDATA
* sections have to be ignored.
*/
private boolean ignoreWhitespace;
/**
* Character read too much.
* This character provides push-back functionality to the input reader
* without having to use a PushbackReader.
* If there is no such character, this field is '\0'.
*/
private char charReadTooMuch;
/**
* The reader provided by the caller of the parse method.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>The field is not <code>null</code> while the parse method
* is running.
* </ul></dd></dl>
*/
private Reader reader;
/**
* The current line number in the source content.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li>parserLineNr > 0 while the parse method is running.
* </ul></dd></dl>
*/
private int parserLineNr;
/**
* Creates and initializes a new XML element.
* Calling the construction is equivalent to:
* <ul><code>new XMLElement(new HashMap<String, char[]>(), false, true)
* </code></ul>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => 0
* <li>enumerateChildren() => empty enumeration
* <li>enumeratePropertyNames() => empty enumeration
* <li>getChildren() => empty vector
* <li>getContent() => ""
* <li>getLineNr() => 0
* <li>getName() => null
* </ul></dd></dl>
*
* @see nanoxml.XMLElement#XMLElement(java.util.Map)
* XMLElement(Map<String, char[]>)
* @see nanoxml.XMLElement#XMLElement(boolean)
* @see nanoxml.XMLElement#XMLElement(java.util.Map,boolean)
* XMLElement(Map<String, char[]>, boolean)
*/
public XMLElement()
{
this(new HashMap<String, char[]>(), false, true, true);
}
/**
* Creates and initializes a new XML element.
* Calling the construction is equivalent to:
* <ul><code>new XMLElement(entities, false, true)
* </code></ul>
*
* @param entities
* The entity conversion table.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>entities != null</code>
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => 0
* <li>enumerateChildren() => empty enumeration
* <li>enumeratePropertyNames() => empty enumeration
* <li>getChildren() => empty vector
* <li>getContent() => ""
* <li>getLineNr() => 0
* <li>getName() => null
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#XMLElement()
* @see nanoxml.XMLElement#XMLElement(boolean)
* @see nanoxml.XMLElement#XMLElement(java.util.Map,boolean)
* XMLElement(Map<String, char[]>, boolean)
*/
public XMLElement(Map<String, char[]> entities)
{
this(entities, false, true, true);
}
/**
* Creates and initializes a new XML element.
* Calling the construction is equivalent to:
* <ul><code>new XMLElement(new HashMap<String, char[]>(), skipLeadingWhitespace, true)
* </code></ul>
*
* @param skipLeadingWhitespace
* <code>true</code> if leading and trailing whitespace in PCDATA
* content has to be removed.
*
* </dl><dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => 0
* <li>enumerateChildren() => empty enumeration
* <li>enumeratePropertyNames() => empty enumeration
* <li>getChildren() => empty vector
* <li>getContent() => ""
* <li>getLineNr() => 0
* <li>getName() => null
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#XMLElement()
* @see nanoxml.XMLElement#XMLElement(java.util.Map)
* XMLElement(Map<String, char[]>)
* @see nanoxml.XMLElement#XMLElement(java.util.Map,boolean)
* XMLElement(Map<String, char[]>, boolean)
*/
public XMLElement(boolean skipLeadingWhitespace)
{
this(new HashMap<String, char[]>(), skipLeadingWhitespace, true, true);
}
/**
* Creates and initializes a new XML element.
* Calling the construction is equivalent to:
* <ul><code>new XMLElement(entities, skipLeadingWhitespace, true)
* </code></ul>
*
* @param entities
* The entity conversion table.
* @param skipLeadingWhitespace
* <code>true</code> if leading and trailing whitespace in PCDATA
* content has to be removed.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>entities != null</code>
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => 0
* <li>enumerateChildren() => empty enumeration
* <li>enumeratePropertyNames() => empty enumeration
* <li>getChildren() => empty vector
* <li>getContent() => ""
* <li>getLineNr() => 0
* <li>getName() => null
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#XMLElement()
* @see nanoxml.XMLElement#XMLElement(boolean)
* @see nanoxml.XMLElement#XMLElement(java.util.Map)
* XMLElement(Map<String, char[]>)
*/
public XMLElement(Map<String, char[]> entities,
boolean skipLeadingWhitespace)
{
this(entities, skipLeadingWhitespace, true, true);
}
/**
* Creates and initializes a new XML element.
*
* @param entities
* The entity conversion table.
* @param skipLeadingWhitespace
* <code>true</code> if leading and trailing whitespace in PCDATA
* content has to be removed.
* @param ignoreCase
* <code>true</code> if the case of element and attribute names have
* to be ignored.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>entities != null</code>
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => 0
* <li>enumerateChildren() => empty enumeration
* <li>enumeratePropertyNames() => empty enumeration
* <li>getChildren() => empty vector
* <li>getContent() => ""
* <li>getLineNr() => 0
* <li>getName() => null
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#XMLElement()
* @see nanoxml.XMLElement#XMLElement(boolean)
* @see nanoxml.XMLElement#XMLElement(java.util.Map)
* XMLElement(Map<String, char[]>)
* @see nanoxml.XMLElement#XMLElement(java.util.Map,boolean)
* XMLElement(Map<String, char[]>, boolean)
*/
public XMLElement(Map<String, char[]> entities,
boolean skipLeadingWhitespace,
boolean ignoreCase)
{
this(entities, skipLeadingWhitespace, true, ignoreCase);
}
/**
* Creates and initializes a new XML element.
* <P>
* This constructor should <I>only</I> be called from
* {@link #createAnotherElement() createAnotherElement}
* to create child elements.
*
* @param entities
* The entity conversion table.
* @param skipLeadingWhitespace
* <code>true</code> if leading and trailing whitespace in PCDATA
* content has to be removed.
* @param fillBasicConversionTable
* <code>true</code> if the basic entities need to be added to
* the entity list.
* @param ignoreCase
* <code>true</code> if the case of element and attribute names have
* to be ignored.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>entities != null</code>
* <li>if <code>fillBasicConversionTable == false</code>
* then <code>entities</code> contains at least the following
* entries: <code>amp</code>, <code>lt</code>, <code>gt</code>,
* <code>apos</code> and <code>quot</code>
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => 0
* <li>enumerateChildren() => empty enumeration
* <li>enumeratePropertyNames() => empty enumeration
* <li>getChildren() => empty vector
* <li>getContent() => ""
* <li>getLineNr() => 0
* <li>getName() => null
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#createAnotherElement()
*/
protected XMLElement(Map<String, char[]> entities,
boolean skipLeadingWhitespace,
boolean fillBasicConversionTable,
boolean ignoreCase)
{
this.ignoreWhitespace = skipLeadingWhitespace;
this.ignoreCase = ignoreCase;
this.name = null;
this.contents = "";
this.attributes = new HashMap<String, String>();
this.children = new ArrayList<XMLElement>();
this.entities = entities;
this.lineNr = 0;
if (fillBasicConversionTable) {
this.entities.put("amp", new char[] { '&' });
this.entities.put("quot", new char[] { '"' });
this.entities.put("apos", new char[] { '\'' });
this.entities.put("lt", new char[] { '<' });
this.entities.put("gt", new char[] { '>' });
}
}
/**
* Adds a child element.
*
* @param child
* The child element to add.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>child != null</code>
* <li><code>child.getName() != null</code>
* <li><code>child</code> does not have a parent element
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>countChildren() => old.countChildren() + 1
* <li>enumerateChildren() => old.enumerateChildren() + child
* <li>getChildren() => old.enumerateChildren() + child
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#countChildren()
* @see nanoxml.XMLElement#enumerateChildren()
* @see nanoxml.XMLElement#getChildren()
* @see nanoxml.XMLElement#removeChild(nanoxml.XMLElement)
* removeChild(XMLElement)
*/
public void addChild(XMLElement child)
{
this.children.add(child);
}
/**
* Adds or modifies an attribute.
*
* @param name
* The name of the attribute.
* @param value
* The value of the attribute.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* <li><code>value != null</code>
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>enumerateAttributeNames()
* => old.enumerateAttributeNames() + name
* <li>getAttribute(name) => value
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setDoubleAttribute(java.lang.String, double)
* setDoubleAttribute(String, double)
* @see nanoxml.XMLElement#setIntAttribute(java.lang.String, int)
* setIntAttribute(String, int)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getAttribute(java.lang.String)
* getAttribute(String)
* @see nanoxml.XMLElement#getAttribute(java.lang.String, java.lang.Object)
* getAttribute(String, Object)
* @see nanoxml.XMLElement#getAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getAttribute(String, Map, String, boolean)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String)
* getStringAttribute(String)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.lang.String)
* getStringAttribute(String, String)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getStringAttribute(String, Map, String, boolean)
*/
public void setAttribute(String name,
Object value)
{
if (this.ignoreCase) {
name = name.toUpperCase();
}
this.attributes.put(name, value.toString());
}
/**
* Adds or modifies an attribute.
*
* @param name
* The name of the attribute.
* @param value
* The value of the attribute.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>enumerateAttributeNames()
* => old.enumerateAttributeNames() + name
* <li>getIntAttribute(name) => value
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setDoubleAttribute(java.lang.String, double)
* setDoubleAttribute(String, double)
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getIntAttribute(java.lang.String)
* getIntAttribute(String)
* @see nanoxml.XMLElement#getIntAttribute(java.lang.String, int)
* getIntAttribute(String, int)
* @see nanoxml.XMLElement#getIntAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getIntAttribute(String, Map, String, boolean)
*/
public void setIntAttribute(String name,
int value)
{
if (this.ignoreCase) {
name = name.toUpperCase();
}
this.attributes.put(name, Integer.toString(value));
}
/**
* Adds or modifies an attribute.
*
* @param name
* The name of the attribute.
* @param value
* The value of the attribute.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* </ul></dd></dl>
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li>enumerateAttributeNames()
* => old.enumerateAttributeNames() + name
* <li>getDoubleAttribute(name) => value
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setIntAttribute(java.lang.String, int)
* setIntAttribute(String, int)
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getDoubleAttribute(java.lang.String)
* getDoubleAttribute(String)
* @see nanoxml.XMLElement#getDoubleAttribute(java.lang.String, double)
* getDoubleAttribute(String, double)
* @see nanoxml.XMLElement#getDoubleAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getDoubleAttribute(String, Map, String, boolean)
*/
public void setDoubleAttribute(String name,
double value)
{
if (this.ignoreCase) {
name = name.toUpperCase();
}
this.attributes.put(name, Double.toString(value));
}
/**
* Returns the number of child elements of the element.
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li><code>result >= 0</code>
* </ul></dd></dl>
*
* @see nanoxml.XMLElement#addChild(nanoxml.XMLElement)
* addChild(XMLElement)
* @see nanoxml.XMLElement#enumerateChildren()
* @see nanoxml.XMLElement#getChildren()
* @see nanoxml.XMLElement#removeChild(nanoxml.XMLElement)
* removeChild(XMLElement)
*/
public int countChildren()
{
return this.children.size();
}
/**
* Enumerates the attribute names.
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li><code>result != null</code>
* </ul></dd></dl>
*
* @see nanoxml.XMLElement#setDoubleAttribute(java.lang.String, double)
* setDoubleAttribute(String, double)
* @see nanoxml.XMLElement#setIntAttribute(java.lang.String, int)
* setIntAttribute(String, int)
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#getAttribute(java.lang.String)
* getAttribute(String)
* @see nanoxml.XMLElement#getAttribute(java.lang.String, java.lang.Object)
* getAttribute(String, String)
* @see nanoxml.XMLElement#getAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getAttribute(String, Map, String, boolean)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String)
* getStringAttribute(String)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.lang.String)
* getStringAttribute(String, String)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getStringAttribute(String, Map, String, boolean)
* @see nanoxml.XMLElement#getIntAttribute(java.lang.String)
* getIntAttribute(String)
* @see nanoxml.XMLElement#getIntAttribute(java.lang.String, int)
* getIntAttribute(String, int)
* @see nanoxml.XMLElement#getIntAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getIntAttribute(String, Map, String, boolean)
* @see nanoxml.XMLElement#getDoubleAttribute(java.lang.String)
* getDoubleAttribute(String)
* @see nanoxml.XMLElement#getDoubleAttribute(java.lang.String, double)
* getDoubleAttribute(String, double)
* @see nanoxml.XMLElement#getDoubleAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getDoubleAttribute(String, Map, String, boolean)
* @see nanoxml.XMLElement#getBooleanAttribute(java.lang.String,
* java.lang.String,
* java.lang.String, boolean)
* getBooleanAttribute(String, String, String, boolean)
*/
public Iterator<String> enumerateAttributeNames()
{
return this.attributes.keySet().iterator();
}
/**
* Enumerates the child elements.
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li><code>result != null</code>
* </ul></dd></dl>
*
* @see nanoxml.XMLElement#addChild(nanoxml.XMLElement)
* addChild(XMLElement)
* @see nanoxml.XMLElement#countChildren()
* @see nanoxml.XMLElement#getChildren()
* @see nanoxml.XMLElement#removeChild(nanoxml.XMLElement)
* removeChild(XMLElement)
*/
public Iterator<XMLElement> enumerateChildren()
{
return this.children.iterator();
}
/**
* Returns the child elements as a Vector. It is safe to modify this
* Vector.
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li><code>result != null</code>
* </ul></dd></dl>
*
* @see nanoxml.XMLElement#addChild(nanoxml.XMLElement)
* addChild(XMLElement)
* @see nanoxml.XMLElement#countChildren()
* @see nanoxml.XMLElement#enumerateChildren()
* @see nanoxml.XMLElement#removeChild(nanoxml.XMLElement)
* removeChild(XMLElement)
*/
public List<XMLElement> getChildren()
{
return new ArrayList<XMLElement>(this.children);
}
/**
* Returns the PCDATA content of the object. If there is no such content,
* <CODE>null</CODE> is returned.
*
* @see nanoxml.XMLElement#setContent(java.lang.String)
* setContent(String)
*/
public String getContent()
{
return this.contents;
}
/**
* Returns the line nr in the source data on which the element is found.
* This method returns <code>0</code> there is no associated source data.
*
* <dl><dt><b>Postconditions:</b></dt><dd>
* <ul><li><code>result >= 0</code>
* </ul></dd></dl>
*/
public int getLineNr()
{
return this.lineNr;
}
/**
* Returns an attribute of the element.
* If the attribute doesn't exist, <code>null</code> is returned.
*
* @param name The name of the attribute.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getAttribute(java.lang.String, java.lang.Object)
* getAttribute(String, Object)
* @see nanoxml.XMLElement#getAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getAttribute(String, Map, String, boolean)
*/
public String getAttribute(String name)
{
return this.getAttribute(name, null);
}
/**
* Returns an attribute of the element.
* If the attribute doesn't exist, <code>defaultValue</code> is returned.
*
* @param name The name of the attribute.
* @param defaultValue Key to use if the attribute is missing.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getAttribute(java.lang.String)
* getAttribute(String)
* @see nanoxml.XMLElement#getAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getAttribute(String, Map, String, boolean)
*/
public String getAttribute(String name,
String defaultValue)
{
if (this.ignoreCase) {
name = name.toUpperCase();
}
String value = this.attributes.get(name);
if (value == null) {
value = defaultValue;
}
return value;
}
/**
* Returns an attribute by looking up a key in a hashtable.
* If the attribute doesn't exist, the value corresponding to defaultKey
* is returned.
* <P>
* As an example, if valueSet contains the mapping <code>"one" =>
* "1"</code>
* and the element contains the attribute <code>attr="one"</code>, then
* <code>getAttribute("attr", mapping, defaultKey, false)</code> returns
* <code>"1"</code>.
*
* @param name
* The name of the attribute.
* @param valueSet
* Map mapping keys to values.
* @param defaultKey
* Key to use if the attribute is missing.
* @param allowLiterals
* <code>true</code> if literals are valid.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* <li><code>valueSet</code> != null
* <li>the keys of <code>valueSet</code> are strings
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getAttribute(java.lang.String)
* getAttribute(String)
* @see nanoxml.XMLElement#getAttribute(java.lang.String, java.lang.Object)
* getAttribute(String, Object)
*/
public Object getAttribute(String name,
Map<? super String, ?> valueSet,
String defaultKey,
boolean allowLiterals)
{
if (this.ignoreCase) {
name = name.toUpperCase();
}
String key = this.attributes.get(name);
Object result;
if (key == null) {
key = defaultKey;
}
result = valueSet.get(key);
if (result == null) {
if (allowLiterals) {
result = key;
} else {
throw this.invalidValue(name, key);
}
}
return result;
}
/**
* Returns an attribute of the element.
* If the attribute doesn't exist, <code>null</code> is returned.
*
* @param name The name of the attribute.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.lang.String)
* getStringAttribute(String, String)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getStringAttribute(String, Map, String, boolean)
*/
public String getStringAttribute(String name)
{
return this.getStringAttribute(name, null);
}
/**
* Returns an attribute of the element.
* If the attribute doesn't exist, <code>defaultValue</code> is returned.
*
* @param name The name of the attribute.
* @param defaultValue Key to use if the attribute is missing.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>name != null</code>
* <li><code>name</code> is a valid XML identifier
* </ul></dd></dl><dl>
*
* @see nanoxml.XMLElement#setAttribute(java.lang.String, java.lang.Object)
* setAttribute(String, Object)
* @see nanoxml.XMLElement#removeAttribute(java.lang.String)
* removeAttribute(String)
* @see nanoxml.XMLElement#enumerateAttributeNames()
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String)
* getStringAttribute(String)
* @see nanoxml.XMLElement#getStringAttribute(java.lang.String,
* java.util.Map,
* java.lang.String, boolean)
* getStringAttribute(String, Map, String, boolean)
*/
public String getStringAttribute(String name,
String defaultValue)
{
return this.getAttribute(name, defaultValue);
}
/**
* Returns an attribute by looking up a key in a hashtable.
* If the attribute doesn't exist, the value corresponding to defaultKey
* is returned.