Class XmlReader
- java.lang.Object
-
- java.io.Reader
-
- org.codehaus.plexus.util.xml.XmlReader
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Readable
- Direct Known Subclasses:
XmlStreamReader
public class XmlReader extends java.io.Reader
Deprecated.use XmlStreamReaderCharacter 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
Fields Modifier and Type Field Description private java.lang.String
_defaultEncoding
Deprecated.private java.lang.String
_encoding
Deprecated.private java.io.Reader
_reader
Deprecated.private static java.lang.String
_staticDefaultEncoding
Deprecated.private static int
BUFFER_SIZE
Deprecated.private static java.util.regex.Pattern
CHARSET_PATTERN
Deprecated.private static java.lang.String
EBCDIC
Deprecated.(package private) static java.util.regex.Pattern
ENCODING_PATTERN
Deprecated.private static java.text.MessageFormat
HTTP_EX_1
Deprecated.private static java.text.MessageFormat
HTTP_EX_2
Deprecated.private static java.text.MessageFormat
HTTP_EX_3
Deprecated.private static java.text.MessageFormat
RAW_EX_1
Deprecated.private static java.text.MessageFormat
RAW_EX_2
Deprecated.private static java.lang.String
US_ASCII
Deprecated.private static java.lang.String
UTF_16
Deprecated.private static java.lang.String
UTF_16BE
Deprecated.private static java.lang.String
UTF_16LE
Deprecated.private static java.lang.String
UTF_8
Deprecated.
-
Constructor Summary
Constructors Constructor Description XmlReader(java.io.File file)
Deprecated.Creates a Reader for a File.XmlReader(java.io.InputStream is)
Deprecated.Creates a Reader for a raw InputStream.XmlReader(java.io.InputStream is, boolean lenient)
Deprecated.Creates a Reader for a raw InputStream.XmlReader(java.io.InputStream is, java.lang.String httpContentType)
Deprecated.Creates a Reader using an InputStream an the associated content-type header.XmlReader(java.io.InputStream is, java.lang.String httpContentType, boolean lenient)
Deprecated.Creates a Reader using an InputStream an the associated content-type header.XmlReader(java.io.InputStream is, java.lang.String httpContentType, boolean lenient, java.lang.String defaultEncoding)
Deprecated.Creates a Reader using an InputStream an the associated content-type header.XmlReader(java.net.URL url)
Deprecated.Creates a Reader using the InputStream of a URL.XmlReader(java.net.URLConnection conn)
Deprecated.Creates a Reader using the InputStream of a URLConnection.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private java.lang.String
calculateHttpEncoding(java.lang.String cTMime, java.lang.String cTEnc, java.lang.String bomEnc, java.lang.String xmlGuessEnc, java.lang.String xmlEnc, java.io.InputStream is, boolean lenient)
Deprecated.private java.lang.String
calculateRawEncoding(java.lang.String bomEnc, java.lang.String xmlGuessEnc, java.lang.String xmlEnc, java.io.InputStream is)
Deprecated.void
close()
Deprecated.Closes the XmlReader stream.private void
doHttpStream(java.io.InputStream is, java.lang.String httpContentType, boolean lenient)
Deprecated.private void
doLenientDetection(java.lang.String httpContentType, XmlStreamReaderException ex)
Deprecated.private void
doRawStream(java.io.InputStream is, boolean lenient)
Deprecated.private static java.lang.String
getBOMEncoding(java.io.BufferedInputStream is)
Deprecated.private static java.lang.String
getContentTypeEncoding(java.lang.String httpContentType)
Deprecated.private static java.lang.String
getContentTypeMime(java.lang.String httpContentType)
Deprecated.static java.lang.String
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.java.lang.String
getEncoding()
Deprecated.Returns the charset encoding of the XmlReader.private static java.lang.String
getXMLGuessEncoding(java.io.BufferedInputStream is)
Deprecated.private static java.lang.String
getXmlProlog(java.io.BufferedInputStream is, java.lang.String guessedEnc)
Deprecated.private static boolean
isAppXml(java.lang.String mime)
Deprecated.private static boolean
isTextXml(java.lang.String mime)
Deprecated.private void
prepareReader(java.io.InputStream is, java.lang.String encoding)
Deprecated.int
read(char[] buf, int offset, int len)
Deprecated.static void
setDefaultEncoding(java.lang.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 Detail
-
BUFFER_SIZE
private static final int BUFFER_SIZE
Deprecated.- See Also:
- Constant Field Values
-
UTF_8
private static final java.lang.String UTF_8
Deprecated.- See Also:
- Constant Field Values
-
US_ASCII
private static final java.lang.String US_ASCII
Deprecated.- See Also:
- Constant Field Values
-
UTF_16BE
private static final java.lang.String UTF_16BE
Deprecated.- See Also:
- Constant Field Values
-
UTF_16LE
private static final java.lang.String UTF_16LE
Deprecated.- See Also:
- Constant Field Values
-
UTF_16
private static final java.lang.String UTF_16
Deprecated.- See Also:
- Constant Field Values
-
EBCDIC
private static final java.lang.String EBCDIC
Deprecated.- See Also:
- Constant Field Values
-
_staticDefaultEncoding
private static java.lang.String _staticDefaultEncoding
Deprecated.
-
_reader
private java.io.Reader _reader
Deprecated.
-
_encoding
private java.lang.String _encoding
Deprecated.
-
_defaultEncoding
private java.lang.String _defaultEncoding
Deprecated.
-
CHARSET_PATTERN
private static final java.util.regex.Pattern CHARSET_PATTERN
Deprecated.
-
ENCODING_PATTERN
static final java.util.regex.Pattern ENCODING_PATTERN
Deprecated.
-
RAW_EX_1
private static final java.text.MessageFormat RAW_EX_1
Deprecated.
-
RAW_EX_2
private static final java.text.MessageFormat RAW_EX_2
Deprecated.
-
HTTP_EX_1
private static final java.text.MessageFormat HTTP_EX_1
Deprecated.
-
HTTP_EX_2
private static final java.text.MessageFormat HTTP_EX_2
Deprecated.
-
HTTP_EX_3
private static final java.text.MessageFormat HTTP_EX_3
Deprecated.
-
-
Constructor Detail
-
XmlReader
public XmlReader(java.io.File file) throws java.io.IOException
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:
java.io.IOException
- thrown if there is a problem reading the file.
-
XmlReader
public XmlReader(java.io.InputStream is) throws java.io.IOException
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:
java.io.IOException
- thrown if there is a problem reading the stream.
-
XmlReader
public XmlReader(java.io.InputStream is, boolean lenient) throws java.io.IOException, XmlStreamReaderException
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:
java.io.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
public XmlReader(java.net.URL url) throws java.io.IOException
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:
java.io.IOException
- thrown if there is a problem reading the stream of the URL.
-
XmlReader
public XmlReader(java.net.URLConnection conn) throws java.io.IOException
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:
java.io.IOException
- thrown if there is a problem reading the stream of the URLConnection.
-
XmlReader
public XmlReader(java.io.InputStream is, java.lang.String httpContentType) throws java.io.IOException
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:
java.io.IOException
- thrown if there is a problem reading the file.
-
XmlReader
public XmlReader(java.io.InputStream is, java.lang.String httpContentType, boolean lenient, java.lang.String defaultEncoding) throws java.io.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:
java.io.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(java.io.InputStream is, java.lang.String httpContentType, boolean lenient) throws java.io.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:
java.io.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 Detail
-
setDefaultEncoding
public static void setDefaultEncoding(java.lang.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.
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
public static java.lang.String 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(java.lang.String httpContentType, XmlStreamReaderException ex) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
getEncoding
public java.lang.String getEncoding()
Deprecated.Returns the charset encoding of the XmlReader.- Returns:
- charset encoding.
-
read
public int read(char[] buf, int offset, int len) throws java.io.IOException
Deprecated.- Specified by:
read
in classjava.io.Reader
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
Deprecated.Closes the XmlReader stream.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classjava.io.Reader
- Throws:
java.io.IOException
- thrown if there was a problem closing the stream.
-
doRawStream
private void doRawStream(java.io.InputStream is, boolean lenient) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
doHttpStream
private void doHttpStream(java.io.InputStream is, java.lang.String httpContentType, boolean lenient) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
prepareReader
private void prepareReader(java.io.InputStream is, java.lang.String encoding) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
calculateRawEncoding
private java.lang.String calculateRawEncoding(java.lang.String bomEnc, java.lang.String xmlGuessEnc, java.lang.String xmlEnc, java.io.InputStream is) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
calculateHttpEncoding
private java.lang.String calculateHttpEncoding(java.lang.String cTMime, java.lang.String cTEnc, java.lang.String bomEnc, java.lang.String xmlGuessEnc, java.lang.String xmlEnc, java.io.InputStream is, boolean lenient) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
getContentTypeMime
private static java.lang.String getContentTypeMime(java.lang.String httpContentType)
Deprecated.
-
getContentTypeEncoding
private static java.lang.String getContentTypeEncoding(java.lang.String httpContentType)
Deprecated.
-
getBOMEncoding
private static java.lang.String getBOMEncoding(java.io.BufferedInputStream is) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
getXMLGuessEncoding
private static java.lang.String getXMLGuessEncoding(java.io.BufferedInputStream is) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
getXmlProlog
private static java.lang.String getXmlProlog(java.io.BufferedInputStream is, java.lang.String guessedEnc) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
isAppXml
private static boolean isAppXml(java.lang.String mime)
Deprecated.
-
isTextXml
private static boolean isTextXml(java.lang.String mime)
Deprecated.
-
-