View Javadoc

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