View Javadoc

1   package org.codehaus.plexus.util.xml;
2   
3   import java.io.InputStream;
4   
5   /**
6    * The XmlStreamReaderException is thrown by the XmlStreamReader constructors if the charset encoding can not be determined
7    * according to the XML 1.0 specification and RFC 3023.
8    * <p>
9    * The exception returns the unconsumed InputStream to allow the application to do an alternate processing with the
10   * stream. Note that the original InputStream given to the XmlStreamReader cannot be used as that one has been already read.
11   * <p>
12   * 
13   * @author Alejandro Abdelnur
14   * @version revision 1.1 taken on 26/06/2007 from Rome (see https://rome.dev.java.net/source/browse/rome/src/java/com/sun/syndication/io/XmlReaderException.java)
15   * @deprecated TO BE REMOVED from here when plexus-utils is upgraded to 1.4.5+ (and prerequisite upgraded to Maven 2.0.6)
16   */
17  public class XmlStreamReaderException extends XmlReaderException
18  {
19      /**
20       * Creates an exception instance if the charset encoding could not be determined.
21       * <p>
22       * Instances of this exception are thrown by the XmlReader.
23       * <p>
24       * 
25       * @param msg
26       *            message describing the reason for the exception.
27       * @param bomEnc
28       *            BOM encoding.
29       * @param xmlGuessEnc
30       *            XML guess encoding.
31       * @param xmlEnc
32       *            XML prolog encoding.
33       * @param is
34       *            the unconsumed InputStream.
35       * 
36       */
37      public XmlStreamReaderException( String msg, String bomEnc, String xmlGuessEnc, String xmlEnc, InputStream is )
38      {
39          super( msg, bomEnc, xmlGuessEnc, xmlEnc, is );
40      }
41  
42      /**
43       * Creates an exception instance if the charset encoding could not be determined.
44       * <p>
45       * Instances of this exception are thrown by the XmlReader.
46       * <p>
47       * 
48       * @param msg
49       *            message describing the reason for the exception.
50       * @param ctMime
51       *            MIME type in the content-type.
52       * @param ctEnc
53       *            encoding in the content-type.
54       * @param bomEnc
55       *            BOM encoding.
56       * @param xmlGuessEnc
57       *            XML guess encoding.
58       * @param xmlEnc
59       *            XML prolog encoding.
60       * @param is
61       *            the unconsumed InputStream.
62       * 
63       */
64      public XmlStreamReaderException( String msg, String ctMime, String ctEnc, String bomEnc, String xmlGuessEnc,
65                                 String xmlEnc, InputStream is )
66      {
67          super( msg, ctMime, ctEnc, bomEnc, xmlGuessEnc, xmlEnc, is );
68      }
69  }