Class XmlReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
- Direct Known Subclasses:
XmlStreamReader
Character stream that handles (or at least attempts to) all the necessary Voodo to figure out the charset encoding of the XML document within the stream.
IMPORTANT: This class is not related in any way to the org.xml.sax.XMLReader. This one IS a character stream.
All this has to be done without consuming characters from the stream, if not the XML parser will not recognized the document as a valid XML. This is not 100% true, but it's close enough (UTF-8 BOM is not handled by all parsers right now, XmlReader handles it and things work in all parsers).
The XmlReader class handles the charset encoding of XML documents in Files, raw streams and HTTP streams by offering a wide set of constructors.
By default the charset encoding detection is lenient, the constructor with the lenient flag can be used for an script (following HTTP MIME and XML specifications). All this is nicely explained by Mark Pilgrim in his blog, Determining the character encoding of a feed.
- Since:
- 1.4.3
- Version:
- revision 1.17 taken on 26/06/2007 from Rome (see https://rome.dev.java.net/source/browse/rome/src/java/com/sun/syndication/io/XmlReader.java)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Deprecated.private String
Deprecated.private Reader
Deprecated.private static String
Deprecated.private static final int
Deprecated.private static final Pattern
Deprecated.private static final String
Deprecated.(package private) static final Pattern
Deprecated.private static final MessageFormat
Deprecated.private static final MessageFormat
Deprecated.private static final MessageFormat
Deprecated.private static final MessageFormat
Deprecated.private static final MessageFormat
Deprecated.private static final String
Deprecated.private static final String
Deprecated.private static final String
Deprecated.private static final String
Deprecated.private static final String
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Creates a Reader for a File.XmlReader
(InputStream is) Deprecated.Creates a Reader for a raw InputStream.XmlReader
(InputStream is, boolean lenient) Deprecated.Creates a Reader for a raw InputStream.XmlReader
(InputStream is, String httpContentType) Deprecated.Creates a Reader using an InputStream an the associated content-type header.XmlReader
(InputStream is, String httpContentType, boolean lenient) Deprecated.Creates a Reader using an InputStream an the associated content-type header.XmlReader
(InputStream is, String httpContentType, boolean lenient, String defaultEncoding) Deprecated.Creates a Reader using an InputStream an the associated content-type header.Deprecated.Creates a Reader using the InputStream of a URL.XmlReader
(URLConnection conn) Deprecated.Creates a Reader using the InputStream of a URLConnection. -
Method Summary
Modifier and TypeMethodDescriptionprivate String
calculateHttpEncoding
(String cTMime, String cTEnc, String bomEnc, String xmlGuessEnc, String xmlEnc, InputStream is, boolean lenient) Deprecated.private String
calculateRawEncoding
(String bomEnc, String xmlGuessEnc, String xmlEnc, InputStream is) Deprecated.void
close()
Deprecated.Closes the XmlReader stream.private void
doHttpStream
(InputStream is, String httpContentType, boolean lenient) Deprecated.private void
doLenientDetection
(String httpContentType, XmlStreamReaderException ex) Deprecated.private void
doRawStream
(InputStream is, boolean lenient) Deprecated.private static String
Deprecated.private static String
getContentTypeEncoding
(String httpContentType) Deprecated.private static String
getContentTypeMime
(String httpContentType) Deprecated.static String
Deprecated.Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.Deprecated.Returns the charset encoding of the XmlReader.private static String
Deprecated.private static String
getXmlProlog
(BufferedInputStream is, String guessedEnc) Deprecated.private static boolean
Deprecated.private static boolean
Deprecated.private void
prepareReader
(InputStream is, String encoding) Deprecated.int
read
(char[] buf, int offset, int len) Deprecated.static void
setDefaultEncoding
(String encoding) Deprecated.Sets the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
-
Field Details
-
BUFFER_SIZE
private static final int BUFFER_SIZEDeprecated.- See Also:
-
UTF_8
Deprecated.- See Also:
-
US_ASCII
Deprecated.- See Also:
-
UTF_16BE
Deprecated.- See Also:
-
UTF_16LE
Deprecated.- See Also:
-
UTF_16
Deprecated.- See Also:
-
EBCDIC
Deprecated.- See Also:
-
_staticDefaultEncoding
Deprecated. -
_reader
Deprecated. -
_encoding
Deprecated. -
_defaultEncoding
Deprecated. -
CHARSET_PATTERN
Deprecated. -
ENCODING_PATTERN
Deprecated. -
RAW_EX_1
Deprecated. -
RAW_EX_2
Deprecated. -
HTTP_EX_1
Deprecated. -
HTTP_EX_2
Deprecated. -
HTTP_EX_3
Deprecated.
-
-
Constructor Details
-
XmlReader
Deprecated.Creates a Reader for a File.It looks for the UTF-8 BOM first, if none sniffs the XML prolog charset, if this is also missing defaults to UTF-8.
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
- Parameters:
file
- File to create a Reader from.- Throws:
IOException
- thrown if there is a problem reading the file.
-
XmlReader
Deprecated.Creates a Reader for a raw InputStream.It follows the same logic used for files.
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
- Parameters:
is
- InputStream to create a Reader from.- Throws:
IOException
- thrown if there is a problem reading the stream.
-
XmlReader
Deprecated.Creates a Reader for a raw InputStream.It follows the same logic used for files.
If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
Else if the XML prolog had a charset encoding that encoding is used.
Else if the content type had a charset encoding that encoding is used.
Else 'UTF-8' is used.
If lenient detection is indicated an XmlStreamReaderException is never thrown.
- Parameters:
is
- InputStream to create a Reader from.lenient
- indicates if the charset encoding detection should be relaxed.- Throws:
IOException
- thrown if there is a problem reading the stream.XmlStreamReaderException
- thrown if the charset encoding could not be determined according to the specs.
-
XmlReader
Deprecated.Creates a Reader using the InputStream of a URL.If the URL is not of type HTTP and there is not 'content-type' header in the fetched data it uses the same logic used for Files.
If the URL is a HTTP Url or there is a 'content-type' header in the fetched data it uses the same logic used for an InputStream with content-type.
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
- Parameters:
url
- URL to create a Reader from.- Throws:
IOException
- thrown if there is a problem reading the stream of the URL.
-
XmlReader
Deprecated.Creates a Reader using the InputStream of a URLConnection.If the URLConnection is not of type HttpURLConnection and there is not 'content-type' header in the fetched data it uses the same logic used for files.
If the URLConnection is a HTTP Url or there is a 'content-type' header in the fetched data it uses the same logic used for an InputStream with content-type.
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
- Parameters:
conn
- URLConnection to create a Reader from.- Throws:
IOException
- thrown if there is a problem reading the stream of the URLConnection.
-
XmlReader
Deprecated.Creates a Reader using an InputStream an the associated content-type header.First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not content-type encoding checks the XML prolog encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type.
It does a lenient charset encoding detection, check the constructor with the lenient parameter for details.
- Parameters:
is
- InputStream to create the reader from.httpContentType
- content-type header to use for the resolution of the charset encoding.- Throws:
IOException
- thrown if there is a problem reading the file.
-
XmlReader
public XmlReader(InputStream is, String httpContentType, boolean lenient, String defaultEncoding) throws IOException, XmlStreamReaderException Deprecated.Creates a Reader using an InputStream an the associated content-type header. This constructor is lenient regarding the encoding detection.First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not content-type encoding checks the XML prolog encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type.
If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
Else if the XML prolog had a charset encoding that encoding is used.
Else if the content type had a charset encoding that encoding is used.
Else 'UTF-8' is used.
If lenient detection is indicated an XmlStreamReaderException is never thrown.
- Parameters:
is
- InputStream to create the reader from.httpContentType
- content-type header to use for the resolution of the charset encoding.lenient
- indicates if the charset encoding detection should be relaxed.defaultEncoding
- encoding to use- Throws:
IOException
- thrown if there is a problem reading the file.XmlStreamReaderException
- thrown if the charset encoding could not be determined according to the specs.
-
XmlReader
public XmlReader(InputStream is, String httpContentType, boolean lenient) throws IOException, XmlStreamReaderException Deprecated.Creates a Reader using an InputStream an the associated content-type header. This constructor is lenient regarding the encoding detection.First it checks if the stream has BOM. If there is not BOM checks the content-type encoding. If there is not content-type encoding checks the XML prolog encoding. If there is not XML prolog encoding uses the default encoding mandated by the content-type MIME type.
If lenient detection is indicated and the detection above fails as per specifications it then attempts the following:
If the content type was 'text/html' it replaces it with 'text/xml' and tries the detection again.
Else if the XML prolog had a charset encoding that encoding is used.
Else if the content type had a charset encoding that encoding is used.
Else 'UTF-8' is used.
If lenient detection is indicated an XmlStreamReaderException is never thrown.
- Parameters:
is
- InputStream to create the reader from.httpContentType
- content-type header to use for the resolution of the charset encoding.lenient
- indicates if the charset encoding detection should be relaxed.- Throws:
IOException
- thrown if there is a problem reading the file.XmlStreamReaderException
- thrown if the charset encoding could not be determined according to the specs.
-
-
Method Details
-
setDefaultEncoding
Deprecated.Sets the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
If it is set to NULL the content-type based rules are used.
By default it is NULL.
- Parameters:
encoding
- charset encoding to default to.
-
getDefaultEncoding
Deprecated.Returns the default encoding to use if none is set in HTTP content-type, XML prolog and the rules based on content-type are not adequate.
If it is NULL the content-type based rules are used.
- Returns:
- the default encoding to use.
-
doLenientDetection
private void doLenientDetection(String httpContentType, XmlStreamReaderException ex) throws IOException Deprecated.- Throws:
IOException
-
getEncoding
Deprecated.Returns the charset encoding of the XmlReader.- Returns:
- charset encoding.
-
read
Deprecated.- Specified by:
read
in classReader
- Throws:
IOException
-
close
Deprecated.Closes the XmlReader stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classReader
- Throws:
IOException
- thrown if there was a problem closing the stream.
-
doRawStream
Deprecated.- Throws:
IOException
-
doHttpStream
private void doHttpStream(InputStream is, String httpContentType, boolean lenient) throws IOException Deprecated.- Throws:
IOException
-
prepareReader
Deprecated.- Throws:
IOException
-
calculateRawEncoding
private String calculateRawEncoding(String bomEnc, String xmlGuessEnc, String xmlEnc, InputStream is) throws IOException Deprecated.- Throws:
IOException
-
calculateHttpEncoding
private String calculateHttpEncoding(String cTMime, String cTEnc, String bomEnc, String xmlGuessEnc, String xmlEnc, InputStream is, boolean lenient) throws IOException Deprecated.- Throws:
IOException
-
getContentTypeMime
Deprecated. -
getContentTypeEncoding
Deprecated. -
getBOMEncoding
Deprecated.- Throws:
IOException
-
getXMLGuessEncoding
Deprecated.- Throws:
IOException
-
getXmlProlog
Deprecated.- Throws:
IOException
-
isAppXml
Deprecated. -
isTextXml
Deprecated.
-