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