View Javadoc

1   package org.apache.maven.shared.utils.xml;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.InputStream;
23  
24  /**
25   * The XmlStreamReaderException is thrown by the XmlStreamReader constructors if the charset encoding can not be determined
26   * according to the XML 1.0 specification and RFC 3023.
27   * <p/>
28   * The exception returns the unconsumed InputStream to allow the application to do an alternate processing with the
29   * stream. Note that the original InputStream given to the XmlStreamReader cannot be used as that one has been already read.
30   * <p/>
31   *
32   * @author Alejandro Abdelnur
33   * @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)
34   */
35  class XmlStreamReaderException
36      extends XmlReaderException
37  {
38      /**
39       * Creates an exception instance if the charset encoding could not be determined.
40       * <p/>
41       * Instances of this exception are thrown by the XmlReader.
42       * <p/>
43       *
44       * @param msg         message describing the reason for the exception.
45       * @param bomEnc      BOM encoding.
46       * @param xmlGuessEnc XML guess encoding.
47       * @param xmlEnc      XML prolog encoding.
48       * @param is          the unconsumed InputStream.
49       */
50      public XmlStreamReaderException( String msg, String bomEnc, String xmlGuessEnc, String xmlEnc, InputStream is )
51      {
52          super( msg, bomEnc, xmlGuessEnc, xmlEnc, is );
53      }
54  
55      /**
56       * Creates an exception instance if the charset encoding could not be determined.
57       * <p/>
58       * Instances of this exception are thrown by the XmlReader.
59       * <p/>
60       *
61       * @param msg         message describing the reason for the exception.
62       * @param ctMime      MIME type in the content-type.
63       * @param ctEnc       encoding in the content-type.
64       * @param bomEnc      BOM encoding.
65       * @param xmlGuessEnc XML guess encoding.
66       * @param xmlEnc      XML prolog encoding.
67       * @param is          the unconsumed InputStream.
68       */
69      public XmlStreamReaderException( String msg, String ctMime, String ctEnc, String bomEnc, String xmlGuessEnc,
70                                       String xmlEnc, InputStream is )
71      {
72          super( msg, ctMime, ctEnc, bomEnc, xmlGuessEnc, xmlEnc, is );
73      }
74  }