View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.0.1 on 2011-06-19 15:23:53,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.plugins.changes.model.io.xpp3;
9   
10    //---------------------------------/
11   //- Imported classes and packages -/
12  //---------------------------------/
13  
14  import java.io.IOException;
15  import java.io.InputStream;
16  import java.io.Reader;
17  import java.text.DateFormat;
18  import java.util.Locale;
19  import org.apache.maven.plugins.changes.model.Action;
20  import org.apache.maven.plugins.changes.model.Author;
21  import org.apache.maven.plugins.changes.model.Body;
22  import org.apache.maven.plugins.changes.model.ChangesDocument;
23  import org.apache.maven.plugins.changes.model.DueTo;
24  import org.apache.maven.plugins.changes.model.FixedIssue;
25  import org.apache.maven.plugins.changes.model.Properties;
26  import org.apache.maven.plugins.changes.model.Release;
27  import org.codehaus.plexus.util.ReaderFactory;
28  import org.codehaus.plexus.util.xml.pull.MXParser;
29  import org.codehaus.plexus.util.xml.pull.XmlPullParser;
30  import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
31  
32  /**
33   * Class ChangesXpp3Reader.
34   * 
35   * @version $Revision: 816603 $ $Date: 2012-05-08 12:53:30 +0000 (Tue, 08 May 2012) $
36   */
37  public class ChangesXpp3Reader
38  {
39  
40        //--------------------------/
41       //- Class/Member Variables -/
42      //--------------------------/
43  
44      /**
45       * If set the parser will be loaded with all single characters
46       * from the XHTML specification.
47       * The entities used:
48       * <ul>
49       * <li>http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent</li>
50       * <li>http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent</li>
51       * <li>http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent</li>
52       * </ul>
53       */
54      private boolean addDefaultEntities = true;
55  
56  
57        //-----------/
58       //- Methods -/
59      //-----------/
60  
61      /**
62       * Method checkFieldWithDuplicate.
63       * 
64       * @param parser
65       * @param parsed
66       * @param alias
67       * @param tagName
68       * @throws XmlPullParserException
69       * @return boolean
70       */
71      private boolean checkFieldWithDuplicate( XmlPullParser parser, String tagName, String alias, java.util.Set parsed )
72          throws XmlPullParserException
73      {
74          if ( !( parser.getName().equals( tagName ) || parser.getName().equals( alias ) ) )
75          {
76              return false;
77          }
78          if ( parsed.contains( tagName ) )
79          {
80              throw new XmlPullParserException( "Duplicated tag: '" + tagName + "'", parser, null );
81          }
82          parsed.add( tagName );
83          return true;
84      } //-- boolean checkFieldWithDuplicate( XmlPullParser, String, String, java.util.Set )
85  
86      /**
87       * Returns the state of the "add default entities" flag.
88       * 
89       * @return boolean
90       */
91      public boolean getAddDefaultEntities()
92      {
93          return addDefaultEntities;
94      } //-- boolean getAddDefaultEntities()
95  
96      /**
97       * Method getBooleanValue.
98       * 
99       * @param s
100      * @param parser
101      * @param attribute
102      * @throws XmlPullParserException
103      * @return boolean
104      */
105     private boolean getBooleanValue( String s, String attribute, XmlPullParser parser )
106         throws XmlPullParserException
107     {
108         return getBooleanValue( s, attribute, parser, null );
109     } //-- boolean getBooleanValue( String, String, XmlPullParser )
110 
111     /**
112      * Method getBooleanValue.
113      * 
114      * @param s
115      * @param defaultValue
116      * @param parser
117      * @param attribute
118      * @throws XmlPullParserException
119      * @return boolean
120      */
121     private boolean getBooleanValue( String s, String attribute, XmlPullParser parser, String defaultValue )
122         throws XmlPullParserException
123     {
124         if ( s != null && s.length() != 0 )
125         {
126             return Boolean.valueOf( s ).booleanValue();
127         }
128         if ( defaultValue != null )
129         {
130             return Boolean.valueOf( defaultValue ).booleanValue();
131         }
132         return false;
133     } //-- boolean getBooleanValue( String, String, XmlPullParser, String )
134 
135     /**
136      * Method getByteValue.
137      * 
138      * @param s
139      * @param strict
140      * @param parser
141      * @param attribute
142      * @throws XmlPullParserException
143      * @return byte
144      */
145     private byte getByteValue( String s, String attribute, XmlPullParser parser, boolean strict )
146         throws XmlPullParserException
147     {
148         if ( s != null )
149         {
150             try
151             {
152                 return Byte.valueOf( s ).byteValue();
153             }
154             catch ( NumberFormatException e )
155             {
156                 if ( strict )
157                 {
158                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a byte", parser, null );
159                 }
160             }
161         }
162         return 0;
163     } //-- byte getByteValue( String, String, XmlPullParser, boolean )
164 
165     /**
166      * Method getCharacterValue.
167      * 
168      * @param s
169      * @param parser
170      * @param attribute
171      * @throws XmlPullParserException
172      * @return char
173      */
174     private char getCharacterValue( String s, String attribute, XmlPullParser parser )
175         throws XmlPullParserException
176     {
177         if ( s != null )
178         {
179             return s.charAt( 0 );
180         }
181         return 0;
182     } //-- char getCharacterValue( String, String, XmlPullParser )
183 
184     /**
185      * Method getDateValue.
186      * 
187      * @param s
188      * @param parser
189      * @param attribute
190      * @throws XmlPullParserException
191      * @return Date
192      */
193     private java.util.Date getDateValue( String s, String attribute, XmlPullParser parser )
194         throws XmlPullParserException
195     {
196         return getDateValue( s, attribute, null, parser );
197     } //-- java.util.Date getDateValue( String, String, XmlPullParser )
198 
199     /**
200      * Method getDateValue.
201      * 
202      * @param s
203      * @param parser
204      * @param dateFormat
205      * @param attribute
206      * @throws XmlPullParserException
207      * @return Date
208      */
209     private java.util.Date getDateValue( String s, String attribute, String dateFormat, XmlPullParser parser )
210         throws XmlPullParserException
211     {
212         if ( s != null )
213         {
214             String effectiveDateFormat = dateFormat;
215             if ( dateFormat == null )
216             {
217                 effectiveDateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSS";
218             }
219             if ( "long".equals( effectiveDateFormat ) )
220             {
221                 try
222                 {
223                     return new java.util.Date( Long.parseLong( s ) );
224                 }
225                 catch ( NumberFormatException e )
226                 {
227                     throw new XmlPullParserException( e.getMessage() );
228                 }
229             }
230             else
231             {
232                 try
233                 {
234                     DateFormat dateParser = new java.text.SimpleDateFormat( effectiveDateFormat, Locale.US );
235                     return dateParser.parse( s );
236                 }
237                 catch ( java.text.ParseException e )
238                 {
239                     throw new XmlPullParserException( e.getMessage() );
240                 }
241             }
242         }
243         return null;
244     } //-- java.util.Date getDateValue( String, String, String, XmlPullParser )
245 
246     /**
247      * Method getDoubleValue.
248      * 
249      * @param s
250      * @param strict
251      * @param parser
252      * @param attribute
253      * @throws XmlPullParserException
254      * @return double
255      */
256     private double getDoubleValue( String s, String attribute, XmlPullParser parser, boolean strict )
257         throws XmlPullParserException
258     {
259         if ( s != null )
260         {
261             try
262             {
263                 return Double.valueOf( s ).doubleValue();
264             }
265             catch ( NumberFormatException e )
266             {
267                 if ( strict )
268                 {
269                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a floating point number", parser, null );
270                 }
271             }
272         }
273         return 0;
274     } //-- double getDoubleValue( String, String, XmlPullParser, boolean )
275 
276     /**
277      * Method getFloatValue.
278      * 
279      * @param s
280      * @param strict
281      * @param parser
282      * @param attribute
283      * @throws XmlPullParserException
284      * @return float
285      */
286     private float getFloatValue( String s, String attribute, XmlPullParser parser, boolean strict )
287         throws XmlPullParserException
288     {
289         if ( s != null )
290         {
291             try
292             {
293                 return Float.valueOf( s ).floatValue();
294             }
295             catch ( NumberFormatException e )
296             {
297                 if ( strict )
298                 {
299                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a floating point number", parser, null );
300                 }
301             }
302         }
303         return 0;
304     } //-- float getFloatValue( String, String, XmlPullParser, boolean )
305 
306     /**
307      * Method getIntegerValue.
308      * 
309      * @param s
310      * @param strict
311      * @param parser
312      * @param attribute
313      * @throws XmlPullParserException
314      * @return int
315      */
316     private int getIntegerValue( String s, String attribute, XmlPullParser parser, boolean strict )
317         throws XmlPullParserException
318     {
319         if ( s != null )
320         {
321             try
322             {
323                 return Integer.valueOf( s ).intValue();
324             }
325             catch ( NumberFormatException e )
326             {
327                 if ( strict )
328                 {
329                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be an integer", parser, null );
330                 }
331             }
332         }
333         return 0;
334     } //-- int getIntegerValue( String, String, XmlPullParser, boolean )
335 
336     /**
337      * Method getLongValue.
338      * 
339      * @param s
340      * @param strict
341      * @param parser
342      * @param attribute
343      * @throws XmlPullParserException
344      * @return long
345      */
346     private long getLongValue( String s, String attribute, XmlPullParser parser, boolean strict )
347         throws XmlPullParserException
348     {
349         if ( s != null )
350         {
351             try
352             {
353                 return Long.valueOf( s ).longValue();
354             }
355             catch ( NumberFormatException e )
356             {
357                 if ( strict )
358                 {
359                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a long integer", parser, null );
360                 }
361             }
362         }
363         return 0;
364     } //-- long getLongValue( String, String, XmlPullParser, boolean )
365 
366     /**
367      * Method getRequiredAttributeValue.
368      * 
369      * @param s
370      * @param strict
371      * @param parser
372      * @param attribute
373      * @throws XmlPullParserException
374      * @return String
375      */
376     private String getRequiredAttributeValue( String s, String attribute, XmlPullParser parser, boolean strict )
377         throws XmlPullParserException
378     {
379         if ( s == null )
380         {
381             if ( strict )
382             {
383                 throw new XmlPullParserException( "Missing required value for attribute '" + attribute + "'", parser, null );
384             }
385         }
386         return s;
387     } //-- String getRequiredAttributeValue( String, String, XmlPullParser, boolean )
388 
389     /**
390      * Method getShortValue.
391      * 
392      * @param s
393      * @param strict
394      * @param parser
395      * @param attribute
396      * @throws XmlPullParserException
397      * @return short
398      */
399     private short getShortValue( String s, String attribute, XmlPullParser parser, boolean strict )
400         throws XmlPullParserException
401     {
402         if ( s != null )
403         {
404             try
405             {
406                 return Short.valueOf( s ).shortValue();
407             }
408             catch ( NumberFormatException e )
409             {
410                 if ( strict )
411                 {
412                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a short integer", parser, null );
413                 }
414             }
415         }
416         return 0;
417     } //-- short getShortValue( String, String, XmlPullParser, boolean )
418 
419     /**
420      * Method getTrimmedValue.
421      * 
422      * @param s
423      * @return String
424      */
425     private String getTrimmedValue( String s )
426     {
427         if ( s != null )
428         {
429             s = s.trim();
430         }
431         return s;
432     } //-- String getTrimmedValue( String )
433 
434     /**
435      * Method parseAction.
436      * 
437      * @param tagName
438      * @param strict
439      * @param parser
440      * @throws IOException
441      * @throws XmlPullParserException
442      * @return Action
443      */
444     private Action parseAction( String tagName, XmlPullParser parser, boolean strict )
445         throws IOException, XmlPullParserException
446     {
447         Action action = new Action();
448         if ( parser.getAttributeValue( "", "dev" ) != null  )
449         {
450             action.setDev( getTrimmedValue( parser.getAttributeValue( "", "dev" ) ) );
451         }
452         if ( parser.getAttributeValue( "", "due-to" ) != null  )
453         {
454             action.setDueTo( getTrimmedValue( parser.getAttributeValue( "", "due-to" ) ) );
455         }
456         if ( parser.getAttributeValue( "", "due-to-email" ) != null  )
457         {
458             action.setDueToEmail( getTrimmedValue( parser.getAttributeValue( "", "due-to-email" ) ) );
459         }
460         if ( parser.getAttributeValue( "", "issue" ) != null  )
461         {
462             action.setIssue( getTrimmedValue( parser.getAttributeValue( "", "issue" ) ) );
463         }
464         if ( parser.getAttributeValue( "", "type" ) != null  )
465         {
466             action.setType( getTrimmedValue( parser.getAttributeValue( "", "type" ) ) );
467         }
468         if ( parser.getAttributeValue( "", "system" ) != null  )
469         {
470             action.setSystem( getTrimmedValue( parser.getAttributeValue( "", "system" ) ) );
471         }
472         if ( parser.getAttributeValue( "", "date" ) != null  )
473         {
474             action.setDate( getTrimmedValue( parser.getAttributeValue( "", "date" ) ) );
475         }
476         parser.next();
477         action.setAction( getTrimmedValue( parser.getText() ) ); 
478         java.util.Set parsed = new java.util.HashSet();
479         while ( parser.nextTag() == XmlPullParser.START_TAG )
480         {
481             if ( checkFieldWithDuplicate( parser, "action", null, parsed ) )
482             {
483             }
484             else if ( parser.getName().equals( "fixes" ) )
485             {
486                 java.util.List fixedIssues = action.getFixedIssues();
487                 if ( fixedIssues == null )
488                 {
489                     fixedIssues = new java.util.ArrayList/*<FixedIssue>*/();
490                     action.setFixedIssues( fixedIssues );
491                 }
492                 fixedIssues.add( parseFixedIssue( "fixes", parser, strict ) );
493             }
494             else if ( parser.getName().equals( "dueto" ) )
495             {
496                 java.util.List dueTos = action.getDueTos();
497                 if ( dueTos == null )
498                 {
499                     dueTos = new java.util.ArrayList/*<DueTo>*/();
500                     action.setDueTos( dueTos );
501                 }
502                 dueTos.add( parseDueTo( "dueto", parser, strict ) );
503             }
504             else
505             {
506                 if ( strict )
507                 {
508                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
509                 }
510                 else
511                 {
512                     // swallow up to end tag since this is not valid
513                     while ( parser.next() != XmlPullParser.END_TAG ) {}
514                 }
515             }
516         }
517         return action;
518     } //-- Action parseAction( String, XmlPullParser, boolean )
519 
520     /**
521      * Method parseAuthor.
522      * 
523      * @param tagName
524      * @param strict
525      * @param parser
526      * @throws IOException
527      * @throws XmlPullParserException
528      * @return Author
529      */
530     private Author parseAuthor( String tagName, XmlPullParser parser, boolean strict )
531         throws IOException, XmlPullParserException
532     {
533         Author author = new Author();
534         if ( parser.getAttributeValue( "", "email" ) != null  )
535         {
536             author.setAuthorEmail( getTrimmedValue( parser.getAttributeValue( "", "email" ) ) );
537         }
538         parser.next();
539         author.setName( getTrimmedValue( parser.getText() ) ); 
540         java.util.Set parsed = new java.util.HashSet();
541         while ( parser.nextTag() == XmlPullParser.START_TAG )
542         {
543             if ( checkFieldWithDuplicate( parser, "name", null, parsed ) )
544             {
545             }
546             else
547             {
548                 if ( strict )
549                 {
550                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
551                 }
552                 else
553                 {
554                     // swallow up to end tag since this is not valid
555                     while ( parser.next() != XmlPullParser.END_TAG ) {}
556                 }
557             }
558         }
559         return author;
560     } //-- Author parseAuthor( String, XmlPullParser, boolean )
561 
562     /**
563      * Method parseBody.
564      * 
565      * @param tagName
566      * @param strict
567      * @param parser
568      * @throws IOException
569      * @throws XmlPullParserException
570      * @return Body
571      */
572     private Body parseBody( String tagName, XmlPullParser parser, boolean strict )
573         throws IOException, XmlPullParserException
574     {
575         Body body = new Body();
576         java.util.Set parsed = new java.util.HashSet();
577         while ( parser.nextTag() == XmlPullParser.START_TAG )
578         {
579             if ( parser.getName().equals( "release" ) )
580             {
581                 java.util.List releases = body.getReleases();
582                 if ( releases == null )
583                 {
584                     releases = new java.util.ArrayList/*<Release>*/();
585                     body.setReleases( releases );
586                 }
587                 releases.add( parseRelease( "release", parser, strict ) );
588             }
589             else
590             {
591                 if ( strict )
592                 {
593                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
594                 }
595                 else
596                 {
597                     // swallow up to end tag since this is not valid
598                     while ( parser.next() != XmlPullParser.END_TAG ) {}
599                 }
600             }
601         }
602         return body;
603     } //-- Body parseBody( String, XmlPullParser, boolean )
604 
605     /**
606      * Method parseChangesDocument.
607      * 
608      * @param tagName
609      * @param strict
610      * @param parser
611      * @throws IOException
612      * @throws XmlPullParserException
613      * @return ChangesDocument
614      */
615     private ChangesDocument parseChangesDocument( String tagName, XmlPullParser parser, boolean strict )
616         throws IOException, XmlPullParserException
617     {
618         ChangesDocument changesDocument = new ChangesDocument();
619         java.util.Set parsed = new java.util.HashSet();
620         int eventType = parser.getEventType();
621         boolean foundRoot = false;
622         while ( eventType != XmlPullParser.END_DOCUMENT )
623         {
624             if ( eventType == XmlPullParser.START_TAG )
625             {
626                 if ( parser.getName().equals( tagName ) )
627                 {
628                     foundRoot = true;
629                 }
630                 else if ( strict && ! foundRoot )
631                 {
632                     throw new XmlPullParserException( "Expected root element '" + tagName + "' but found '" + parser.getName() + "'", parser, null );
633                 }
634                 else if ( checkFieldWithDuplicate( parser, "properties", null, parsed ) )
635                 {
636                     changesDocument.setProperties( parseProperties( "properties", parser, strict ) );
637                 }
638                 else if ( checkFieldWithDuplicate( parser, "body", null, parsed ) )
639                 {
640                     changesDocument.setBody( parseBody( "body", parser, strict ) );
641                 }
642                 else if ( strict )
643                 {
644                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
645                 }
646             }
647             eventType = parser.next();
648         }
649         return changesDocument;
650     } //-- ChangesDocument parseChangesDocument( String, XmlPullParser, boolean )
651 
652     /**
653      * Method parseDueTo.
654      * 
655      * @param tagName
656      * @param strict
657      * @param parser
658      * @throws IOException
659      * @throws XmlPullParserException
660      * @return DueTo
661      */
662     private DueTo parseDueTo( String tagName, XmlPullParser parser, boolean strict )
663         throws IOException, XmlPullParserException
664     {
665         DueTo dueTo = new DueTo();
666         if ( parser.getAttributeValue( "", "name" ) != null  )
667         {
668             dueTo.setName( getTrimmedValue( parser.getAttributeValue( "", "name" ) ) );
669         }
670         if ( parser.getAttributeValue( "", "email" ) != null  )
671         {
672             dueTo.setEmail( getTrimmedValue( parser.getAttributeValue( "", "email" ) ) );
673         }
674         java.util.Set parsed = new java.util.HashSet();
675         while ( parser.nextTag() == XmlPullParser.START_TAG )
676         {
677             if ( strict )
678             {
679                 throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
680             }
681             else
682             {
683                 // swallow up to end tag since this is not valid
684                 while ( parser.next() != XmlPullParser.END_TAG ) {}
685             }
686         }
687         return dueTo;
688     } //-- DueTo parseDueTo( String, XmlPullParser, boolean )
689 
690     /**
691      * Method parseFixedIssue.
692      * 
693      * @param tagName
694      * @param strict
695      * @param parser
696      * @throws IOException
697      * @throws XmlPullParserException
698      * @return FixedIssue
699      */
700     private FixedIssue parseFixedIssue( String tagName, XmlPullParser parser, boolean strict )
701         throws IOException, XmlPullParserException
702     {
703         FixedIssue fixedIssue = new FixedIssue();
704         if ( parser.getAttributeValue( "", "issue" ) != null  )
705         {
706             fixedIssue.setIssue( getTrimmedValue( parser.getAttributeValue( "", "issue" ) ) );
707         }
708         java.util.Set parsed = new java.util.HashSet();
709         while ( parser.nextTag() == XmlPullParser.START_TAG )
710         {
711             if ( strict )
712             {
713                 throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
714             }
715             else
716             {
717                 // swallow up to end tag since this is not valid
718                 while ( parser.next() != XmlPullParser.END_TAG ) {}
719             }
720         }
721         return fixedIssue;
722     } //-- FixedIssue parseFixedIssue( String, XmlPullParser, boolean )
723 
724     /**
725      * Method parseProperties.
726      * 
727      * @param tagName
728      * @param strict
729      * @param parser
730      * @throws IOException
731      * @throws XmlPullParserException
732      * @return Properties
733      */
734     private Properties parseProperties( String tagName, XmlPullParser parser, boolean strict )
735         throws IOException, XmlPullParserException
736     {
737         Properties properties = new Properties();
738         java.util.Set parsed = new java.util.HashSet();
739         while ( parser.nextTag() == XmlPullParser.START_TAG )
740         {
741             if ( checkFieldWithDuplicate( parser, "title", null, parsed ) )
742             {
743                 properties.setTitle( getTrimmedValue( parser.nextText() ) );
744             }
745             else if ( checkFieldWithDuplicate( parser, "author", null, parsed ) )
746             {
747                 properties.setAuthor( parseAuthor( "author", parser, strict ) );
748             }
749             else
750             {
751                 if ( strict )
752                 {
753                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
754                 }
755                 else
756                 {
757                     // swallow up to end tag since this is not valid
758                     while ( parser.next() != XmlPullParser.END_TAG ) {}
759                 }
760             }
761         }
762         return properties;
763     } //-- Properties parseProperties( String, XmlPullParser, boolean )
764 
765     /**
766      * Method parseRelease.
767      * 
768      * @param tagName
769      * @param strict
770      * @param parser
771      * @throws IOException
772      * @throws XmlPullParserException
773      * @return Release
774      */
775     private Release parseRelease( String tagName, XmlPullParser parser, boolean strict )
776         throws IOException, XmlPullParserException
777     {
778         Release release = new Release();
779         if ( parser.getAttributeValue( "", "version" ) != null  )
780         {
781             release.setVersion( getTrimmedValue( parser.getAttributeValue( "", "version" ) ) );
782         }
783         if ( parser.getAttributeValue( "", "date" ) != null  )
784         {
785             release.setDateRelease( getTrimmedValue( parser.getAttributeValue( "", "date" ) ) );
786         }
787         if ( parser.getAttributeValue( "", "description" ) != null  )
788         {
789             release.setDescription( getTrimmedValue( parser.getAttributeValue( "", "description" ) ) );
790         }
791         java.util.Set parsed = new java.util.HashSet();
792         while ( parser.nextTag() == XmlPullParser.START_TAG )
793         {
794             if ( parser.getName().equals( "action" ) )
795             {
796                 java.util.List actions = release.getActions();
797                 if ( actions == null )
798                 {
799                     actions = new java.util.ArrayList/*<Action>*/();
800                     release.setActions( actions );
801                 }
802                 actions.add( parseAction( "action", parser, strict ) );
803             }
804             else
805             {
806                 if ( strict )
807                 {
808                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
809                 }
810                 else
811                 {
812                     // swallow up to end tag since this is not valid
813                     while ( parser.next() != XmlPullParser.END_TAG ) {}
814                 }
815             }
816         }
817         return release;
818     } //-- Release parseRelease( String, XmlPullParser, boolean )
819 
820     /**
821      * @see ReaderFactory#newXmlReader
822      * 
823      * @param reader
824      * @param strict
825      * @throws IOException
826      * @throws XmlPullParserException
827      * @return ChangesDocument
828      */
829     public ChangesDocument read( Reader reader, boolean strict )
830         throws IOException, XmlPullParserException
831     {
832         XmlPullParser parser = new MXParser();
833 
834         parser.setInput( reader );
835 
836         if ( addDefaultEntities )
837         {
838             // ----------------------------------------------------------------------
839             // Latin 1 entities
840             // ----------------------------------------------------------------------
841 
842             parser.defineEntityReplacementText( "nbsp", "\u00a0" );
843             parser.defineEntityReplacementText( "iexcl", "\u00a1" );
844             parser.defineEntityReplacementText( "cent", "\u00a2" );
845             parser.defineEntityReplacementText( "pound", "\u00a3" );
846             parser.defineEntityReplacementText( "curren", "\u00a4" );
847             parser.defineEntityReplacementText( "yen", "\u00a5" );
848             parser.defineEntityReplacementText( "brvbar", "\u00a6" );
849             parser.defineEntityReplacementText( "sect", "\u00a7" );
850             parser.defineEntityReplacementText( "uml", "\u00a8" );
851             parser.defineEntityReplacementText( "copy", "\u00a9" );
852             parser.defineEntityReplacementText( "ordf", "\u00aa" );
853             parser.defineEntityReplacementText( "laquo", "\u00ab" );
854             parser.defineEntityReplacementText( "not", "\u00ac" );
855             parser.defineEntityReplacementText( "shy", "\u00ad" );
856             parser.defineEntityReplacementText( "reg", "\u00ae" );
857             parser.defineEntityReplacementText( "macr", "\u00af" );
858             parser.defineEntityReplacementText( "deg", "\u00b0" );
859             parser.defineEntityReplacementText( "plusmn", "\u00b1" );
860             parser.defineEntityReplacementText( "sup2", "\u00b2" );
861             parser.defineEntityReplacementText( "sup3", "\u00b3" );
862             parser.defineEntityReplacementText( "acute", "\u00b4" );
863             parser.defineEntityReplacementText( "micro", "\u00b5" );
864             parser.defineEntityReplacementText( "para", "\u00b6" );
865             parser.defineEntityReplacementText( "middot", "\u00b7" );
866             parser.defineEntityReplacementText( "cedil", "\u00b8" );
867             parser.defineEntityReplacementText( "sup1", "\u00b9" );
868             parser.defineEntityReplacementText( "ordm", "\u00ba" );
869             parser.defineEntityReplacementText( "raquo", "\u00bb" );
870             parser.defineEntityReplacementText( "frac14", "\u00bc" );
871             parser.defineEntityReplacementText( "frac12", "\u00bd" );
872             parser.defineEntityReplacementText( "frac34", "\u00be" );
873             parser.defineEntityReplacementText( "iquest", "\u00bf" );
874             parser.defineEntityReplacementText( "Agrave", "\u00c0" );
875             parser.defineEntityReplacementText( "Aacute", "\u00c1" );
876             parser.defineEntityReplacementText( "Acirc", "\u00c2" );
877             parser.defineEntityReplacementText( "Atilde", "\u00c3" );
878             parser.defineEntityReplacementText( "Auml", "\u00c4" );
879             parser.defineEntityReplacementText( "Aring", "\u00c5" );
880             parser.defineEntityReplacementText( "AElig", "\u00c6" );
881             parser.defineEntityReplacementText( "Ccedil", "\u00c7" );
882             parser.defineEntityReplacementText( "Egrave", "\u00c8" );
883             parser.defineEntityReplacementText( "Eacute", "\u00c9" );
884             parser.defineEntityReplacementText( "Ecirc", "\u00ca" );
885             parser.defineEntityReplacementText( "Euml", "\u00cb" );
886             parser.defineEntityReplacementText( "Igrave", "\u00cc" );
887             parser.defineEntityReplacementText( "Iacute", "\u00cd" );
888             parser.defineEntityReplacementText( "Icirc", "\u00ce" );
889             parser.defineEntityReplacementText( "Iuml", "\u00cf" );
890             parser.defineEntityReplacementText( "ETH", "\u00d0" );
891             parser.defineEntityReplacementText( "Ntilde", "\u00d1" );
892             parser.defineEntityReplacementText( "Ograve", "\u00d2" );
893             parser.defineEntityReplacementText( "Oacute", "\u00d3" );
894             parser.defineEntityReplacementText( "Ocirc", "\u00d4" );
895             parser.defineEntityReplacementText( "Otilde", "\u00d5" );
896             parser.defineEntityReplacementText( "Ouml", "\u00d6" );
897             parser.defineEntityReplacementText( "times", "\u00d7" );
898             parser.defineEntityReplacementText( "Oslash", "\u00d8" );
899             parser.defineEntityReplacementText( "Ugrave", "\u00d9" );
900             parser.defineEntityReplacementText( "Uacute", "\u00da" );
901             parser.defineEntityReplacementText( "Ucirc", "\u00db" );
902             parser.defineEntityReplacementText( "Uuml", "\u00dc" );
903             parser.defineEntityReplacementText( "Yacute", "\u00dd" );
904             parser.defineEntityReplacementText( "THORN", "\u00de" );
905             parser.defineEntityReplacementText( "szlig", "\u00df" );
906             parser.defineEntityReplacementText( "agrave", "\u00e0" );
907             parser.defineEntityReplacementText( "aacute", "\u00e1" );
908             parser.defineEntityReplacementText( "acirc", "\u00e2" );
909             parser.defineEntityReplacementText( "atilde", "\u00e3" );
910             parser.defineEntityReplacementText( "auml", "\u00e4" );
911             parser.defineEntityReplacementText( "aring", "\u00e5" );
912             parser.defineEntityReplacementText( "aelig", "\u00e6" );
913             parser.defineEntityReplacementText( "ccedil", "\u00e7" );
914             parser.defineEntityReplacementText( "egrave", "\u00e8" );
915             parser.defineEntityReplacementText( "eacute", "\u00e9" );
916             parser.defineEntityReplacementText( "ecirc", "\u00ea" );
917             parser.defineEntityReplacementText( "euml", "\u00eb" );
918             parser.defineEntityReplacementText( "igrave", "\u00ec" );
919             parser.defineEntityReplacementText( "iacute", "\u00ed" );
920             parser.defineEntityReplacementText( "icirc", "\u00ee" );
921             parser.defineEntityReplacementText( "iuml", "\u00ef" );
922             parser.defineEntityReplacementText( "eth", "\u00f0" );
923             parser.defineEntityReplacementText( "ntilde", "\u00f1" );
924             parser.defineEntityReplacementText( "ograve", "\u00f2" );
925             parser.defineEntityReplacementText( "oacute", "\u00f3" );
926             parser.defineEntityReplacementText( "ocirc", "\u00f4" );
927             parser.defineEntityReplacementText( "otilde", "\u00f5" );
928             parser.defineEntityReplacementText( "ouml", "\u00f6" );
929             parser.defineEntityReplacementText( "divide", "\u00f7" );
930             parser.defineEntityReplacementText( "oslash", "\u00f8" );
931             parser.defineEntityReplacementText( "ugrave", "\u00f9" );
932             parser.defineEntityReplacementText( "uacute", "\u00fa" );
933             parser.defineEntityReplacementText( "ucirc", "\u00fb" );
934             parser.defineEntityReplacementText( "uuml", "\u00fc" );
935             parser.defineEntityReplacementText( "yacute", "\u00fd" );
936             parser.defineEntityReplacementText( "thorn", "\u00fe" );
937             parser.defineEntityReplacementText( "yuml", "\u00ff" );
938 
939             // ----------------------------------------------------------------------
940             // Special entities
941             // ----------------------------------------------------------------------
942 
943             parser.defineEntityReplacementText( "OElig", "\u0152" );
944             parser.defineEntityReplacementText( "oelig", "\u0153" );
945             parser.defineEntityReplacementText( "Scaron", "\u0160" );
946             parser.defineEntityReplacementText( "scaron", "\u0161" );
947             parser.defineEntityReplacementText( "Yuml", "\u0178" );
948             parser.defineEntityReplacementText( "circ", "\u02c6" );
949             parser.defineEntityReplacementText( "tilde", "\u02dc" );
950             parser.defineEntityReplacementText( "ensp", "\u2002" );
951             parser.defineEntityReplacementText( "emsp", "\u2003" );
952             parser.defineEntityReplacementText( "thinsp", "\u2009" );
953             parser.defineEntityReplacementText( "zwnj", "\u200c" );
954             parser.defineEntityReplacementText( "zwj", "\u200d" );
955             parser.defineEntityReplacementText( "lrm", "\u200e" );
956             parser.defineEntityReplacementText( "rlm", "\u200f" );
957             parser.defineEntityReplacementText( "ndash", "\u2013" );
958             parser.defineEntityReplacementText( "mdash", "\u2014" );
959             parser.defineEntityReplacementText( "lsquo", "\u2018" );
960             parser.defineEntityReplacementText( "rsquo", "\u2019" );
961             parser.defineEntityReplacementText( "sbquo", "\u201a" );
962             parser.defineEntityReplacementText( "ldquo", "\u201c" );
963             parser.defineEntityReplacementText( "rdquo", "\u201d" );
964             parser.defineEntityReplacementText( "bdquo", "\u201e" );
965             parser.defineEntityReplacementText( "dagger", "\u2020" );
966             parser.defineEntityReplacementText( "Dagger", "\u2021" );
967             parser.defineEntityReplacementText( "permil", "\u2030" );
968             parser.defineEntityReplacementText( "lsaquo", "\u2039" );
969             parser.defineEntityReplacementText( "rsaquo", "\u203a" );
970             parser.defineEntityReplacementText( "euro", "\u20ac" );
971 
972             // ----------------------------------------------------------------------
973             // Symbol entities
974             // ----------------------------------------------------------------------
975 
976             parser.defineEntityReplacementText( "fnof", "\u0192" );
977             parser.defineEntityReplacementText( "Alpha", "\u0391" );
978             parser.defineEntityReplacementText( "Beta", "\u0392" );
979             parser.defineEntityReplacementText( "Gamma", "\u0393" );
980             parser.defineEntityReplacementText( "Delta", "\u0394" );
981             parser.defineEntityReplacementText( "Epsilon", "\u0395" );
982             parser.defineEntityReplacementText( "Zeta", "\u0396" );
983             parser.defineEntityReplacementText( "Eta", "\u0397" );
984             parser.defineEntityReplacementText( "Theta", "\u0398" );
985             parser.defineEntityReplacementText( "Iota", "\u0399" );
986             parser.defineEntityReplacementText( "Kappa", "\u039a" );
987             parser.defineEntityReplacementText( "Lambda", "\u039b" );
988             parser.defineEntityReplacementText( "Mu", "\u039c" );
989             parser.defineEntityReplacementText( "Nu", "\u039d" );
990             parser.defineEntityReplacementText( "Xi", "\u039e" );
991             parser.defineEntityReplacementText( "Omicron", "\u039f" );
992             parser.defineEntityReplacementText( "Pi", "\u03a0" );
993             parser.defineEntityReplacementText( "Rho", "\u03a1" );
994             parser.defineEntityReplacementText( "Sigma", "\u03a3" );
995             parser.defineEntityReplacementText( "Tau", "\u03a4" );
996             parser.defineEntityReplacementText( "Upsilon", "\u03a5" );
997             parser.defineEntityReplacementText( "Phi", "\u03a6" );
998             parser.defineEntityReplacementText( "Chi", "\u03a7" );
999             parser.defineEntityReplacementText( "Psi", "\u03a8" );
1000             parser.defineEntityReplacementText( "Omega", "\u03a9" );
1001             parser.defineEntityReplacementText( "alpha", "\u03b1" );
1002             parser.defineEntityReplacementText( "beta", "\u03b2" );
1003             parser.defineEntityReplacementText( "gamma", "\u03b3" );
1004             parser.defineEntityReplacementText( "delta", "\u03b4" );
1005             parser.defineEntityReplacementText( "epsilon", "\u03b5" );
1006             parser.defineEntityReplacementText( "zeta", "\u03b6" );
1007             parser.defineEntityReplacementText( "eta", "\u03b7" );
1008             parser.defineEntityReplacementText( "theta", "\u03b8" );
1009             parser.defineEntityReplacementText( "iota", "\u03b9" );
1010             parser.defineEntityReplacementText( "kappa", "\u03ba" );
1011             parser.defineEntityReplacementText( "lambda", "\u03bb" );
1012             parser.defineEntityReplacementText( "mu", "\u03bc" );
1013             parser.defineEntityReplacementText( "nu", "\u03bd" );
1014             parser.defineEntityReplacementText( "xi", "\u03be" );
1015             parser.defineEntityReplacementText( "omicron", "\u03bf" );
1016             parser.defineEntityReplacementText( "pi", "\u03c0" );
1017             parser.defineEntityReplacementText( "rho", "\u03c1" );
1018             parser.defineEntityReplacementText( "sigmaf", "\u03c2" );
1019             parser.defineEntityReplacementText( "sigma", "\u03c3" );
1020             parser.defineEntityReplacementText( "tau", "\u03c4" );
1021             parser.defineEntityReplacementText( "upsilon", "\u03c5" );
1022             parser.defineEntityReplacementText( "phi", "\u03c6" );
1023             parser.defineEntityReplacementText( "chi", "\u03c7" );
1024             parser.defineEntityReplacementText( "psi", "\u03c8" );
1025             parser.defineEntityReplacementText( "omega", "\u03c9" );
1026             parser.defineEntityReplacementText( "thetasym", "\u03d1" );
1027             parser.defineEntityReplacementText( "upsih", "\u03d2" );
1028             parser.defineEntityReplacementText( "piv", "\u03d6" );
1029             parser.defineEntityReplacementText( "bull", "\u2022" );
1030             parser.defineEntityReplacementText( "hellip", "\u2026" );
1031             parser.defineEntityReplacementText( "prime", "\u2032" );
1032             parser.defineEntityReplacementText( "Prime", "\u2033" );
1033             parser.defineEntityReplacementText( "oline", "\u203e" );
1034             parser.defineEntityReplacementText( "frasl", "\u2044" );
1035             parser.defineEntityReplacementText( "weierp", "\u2118" );
1036             parser.defineEntityReplacementText( "image", "\u2111" );
1037             parser.defineEntityReplacementText( "real", "\u211c" );
1038             parser.defineEntityReplacementText( "trade", "\u2122" );
1039             parser.defineEntityReplacementText( "alefsym", "\u2135" );
1040             parser.defineEntityReplacementText( "larr", "\u2190" );
1041             parser.defineEntityReplacementText( "uarr", "\u2191" );
1042             parser.defineEntityReplacementText( "rarr", "\u2192" );
1043             parser.defineEntityReplacementText( "darr", "\u2193" );
1044             parser.defineEntityReplacementText( "harr", "\u2194" );
1045             parser.defineEntityReplacementText( "crarr", "\u21b5" );
1046             parser.defineEntityReplacementText( "lArr", "\u21d0" );
1047             parser.defineEntityReplacementText( "uArr", "\u21d1" );
1048             parser.defineEntityReplacementText( "rArr", "\u21d2" );
1049             parser.defineEntityReplacementText( "dArr", "\u21d3" );
1050             parser.defineEntityReplacementText( "hArr", "\u21d4" );
1051             parser.defineEntityReplacementText( "forall", "\u2200" );
1052             parser.defineEntityReplacementText( "part", "\u2202" );
1053             parser.defineEntityReplacementText( "exist", "\u2203" );
1054             parser.defineEntityReplacementText( "empty", "\u2205" );
1055             parser.defineEntityReplacementText( "nabla", "\u2207" );
1056             parser.defineEntityReplacementText( "isin", "\u2208" );
1057             parser.defineEntityReplacementText( "notin", "\u2209" );
1058             parser.defineEntityReplacementText( "ni", "\u220b" );
1059             parser.defineEntityReplacementText( "prod", "\u220f" );
1060             parser.defineEntityReplacementText( "sum", "\u2211" );
1061             parser.defineEntityReplacementText( "minus", "\u2212" );
1062             parser.defineEntityReplacementText( "lowast", "\u2217" );
1063             parser.defineEntityReplacementText( "radic", "\u221a" );
1064             parser.defineEntityReplacementText( "prop", "\u221d" );
1065             parser.defineEntityReplacementText( "infin", "\u221e" );
1066             parser.defineEntityReplacementText( "ang", "\u2220" );
1067             parser.defineEntityReplacementText( "and", "\u2227" );
1068             parser.defineEntityReplacementText( "or", "\u2228" );
1069             parser.defineEntityReplacementText( "cap", "\u2229" );
1070             parser.defineEntityReplacementText( "cup", "\u222a" );
1071             parser.defineEntityReplacementText( "int", "\u222b" );
1072             parser.defineEntityReplacementText( "there4", "\u2234" );
1073             parser.defineEntityReplacementText( "sim", "\u223c" );
1074             parser.defineEntityReplacementText( "cong", "\u2245" );
1075             parser.defineEntityReplacementText( "asymp", "\u2248" );
1076             parser.defineEntityReplacementText( "ne", "\u2260" );
1077             parser.defineEntityReplacementText( "equiv", "\u2261" );
1078             parser.defineEntityReplacementText( "le", "\u2264" );
1079             parser.defineEntityReplacementText( "ge", "\u2265" );
1080             parser.defineEntityReplacementText( "sub", "\u2282" );
1081             parser.defineEntityReplacementText( "sup", "\u2283" );
1082             parser.defineEntityReplacementText( "nsub", "\u2284" );
1083             parser.defineEntityReplacementText( "sube", "\u2286" );
1084             parser.defineEntityReplacementText( "supe", "\u2287" );
1085             parser.defineEntityReplacementText( "oplus", "\u2295" );
1086             parser.defineEntityReplacementText( "otimes", "\u2297" );
1087             parser.defineEntityReplacementText( "perp", "\u22a5" );
1088             parser.defineEntityReplacementText( "sdot", "\u22c5" );
1089             parser.defineEntityReplacementText( "lceil", "\u2308" );
1090             parser.defineEntityReplacementText( "rceil", "\u2309" );
1091             parser.defineEntityReplacementText( "lfloor", "\u230a" );
1092             parser.defineEntityReplacementText( "rfloor", "\u230b" );
1093             parser.defineEntityReplacementText( "lang", "\u2329" );
1094             parser.defineEntityReplacementText( "rang", "\u232a" );
1095             parser.defineEntityReplacementText( "loz", "\u25ca" );
1096             parser.defineEntityReplacementText( "spades", "\u2660" );
1097             parser.defineEntityReplacementText( "clubs", "\u2663" );
1098             parser.defineEntityReplacementText( "hearts", "\u2665" );
1099             parser.defineEntityReplacementText( "diams", "\u2666" );
1100 
1101         }
1102 
1103         parser.next();
1104         return parseChangesDocument( "document", parser, strict );
1105     } //-- ChangesDocument read( Reader, boolean )
1106 
1107     /**
1108      * @see ReaderFactory#newXmlReader
1109      * 
1110      * @param reader
1111      * @throws IOException
1112      * @throws XmlPullParserException
1113      * @return ChangesDocument
1114      */
1115     public ChangesDocument read( Reader reader )
1116         throws IOException, XmlPullParserException
1117     {
1118         return read( reader, true );
1119     } //-- ChangesDocument read( Reader )
1120 
1121     /**
1122      * Method read.
1123      * 
1124      * @param in
1125      * @param strict
1126      * @throws IOException
1127      * @throws XmlPullParserException
1128      * @return ChangesDocument
1129      */
1130     public ChangesDocument read( InputStream in, boolean strict )
1131         throws IOException, XmlPullParserException
1132     {
1133         Reader reader = ReaderFactory.newXmlReader( in );
1134 
1135         return read( reader, strict );
1136     } //-- ChangesDocument read( InputStream, boolean )
1137 
1138     /**
1139      * Method read.
1140      * 
1141      * @param in
1142      * @throws IOException
1143      * @throws XmlPullParserException
1144      * @return ChangesDocument
1145      */
1146     public ChangesDocument read( InputStream in )
1147         throws IOException, XmlPullParserException
1148     {
1149         Reader reader = ReaderFactory.newXmlReader( in );
1150 
1151         return read( reader );
1152     } //-- ChangesDocument read( InputStream )
1153 
1154     /**
1155      * Sets the state of the "add default entities" flag.
1156      * 
1157      * @param addDefaultEntities
1158      */
1159     public void setAddDefaultEntities( boolean addDefaultEntities )
1160     {
1161         this.addDefaultEntities = addDefaultEntities;
1162     } //-- void setAddDefaultEntities( boolean )
1163 
1164 
1165 }