Class XmlHeaderAwareReader

java.lang.Object

java.io.Reader

com.thoughtworks.xstream.core.util.XmlHeaderAwareReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class XmlHeaderAwareReader
extends Reader

A Reader that evaluates the XML header. It selects its encoding based on the encoding read with the XML header of the provided InputStream. The default encoding is UTF-8 and the version is 1.0 if the stream does not contain an XML header or the attributes are not set within the header.

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	KEY_ENCODING
private static final String	KEY_VERSION
private final InputStreamReader	reader
private static final int	STATE_ATTR_NAME
private static final int	STATE_ATTR_VALUE
private static final int	STATE_AWAIT_XML_HEADER
private static final int	STATE_BOM
private static final int	STATE_START
private final double	version
private static final String	XML_TOKEN

Fields inherited from class Reader

lock

Constructor Summary

Constructors

Constructor	Description
XmlHeaderAwareReader(InputStream in)	Constructs an XmlHeaderAwareReader.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object obj)
String	getEncoding()
private Map	getHeader(PushbackInputStream[] in)
double	getVersion()
int	hashCode()
void	mark(int readAheadLimit)
boolean	markSupported()
int	read()
int	read(char[] cbuf)
int	read(char[] cbuf, int offset, int length)
boolean	ready()
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class Reader

nullReader, of, read, readAllAsString, readAllLines, transferTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

reader

private final InputStreamReader reader

version

private final double version

KEY_ENCODING

private static final String KEY_ENCODING

See Also:

• Constant Field Values

KEY_VERSION

private static final String KEY_VERSION

See Also:

• Constant Field Values

XML_TOKEN

private static final String XML_TOKEN

See Also:

• Constant Field Values

STATE_BOM

private static final int STATE_BOM

See Also:

• Constant Field Values

STATE_START

private static final int STATE_START

See Also:

• Constant Field Values

STATE_AWAIT_XML_HEADER

private static final int STATE_AWAIT_XML_HEADER

See Also:

• Constant Field Values

STATE_ATTR_NAME

private static final int STATE_ATTR_NAME

See Also:

• Constant Field Values

STATE_ATTR_VALUE

private static final int STATE_ATTR_VALUE

See Also:

• Constant Field Values

Constructor Details

XmlHeaderAwareReader

public XmlHeaderAwareReader(InputStream in)
                     throws UnsupportedEncodingException,
IOException

Constructs an XmlHeaderAwareReader.

Parameters:

in - the InputStream

Throws:

UnsupportedEncodingException - if the encoding is not supported

IOException - occurred while reading the XML header

Since:

1.3

Method Details

getHeader

private Map getHeader(PushbackInputStream[] in)
               throws IOException

Throws:

IOException

getEncoding

public String getEncoding()

Since:

1.3

See Also:

• InputStreamReader.getEncoding()

getVersion

public double getVersion()

Since:

1.3

See Also:

• InputStreamReader.getEncoding()

mark

public void mark(int readAheadLimit)
          throws IOException

Overrides:

mark in class Reader

Throws:

IOException

See Also:

• Reader.mark(int)

markSupported

public boolean markSupported()

Overrides:

markSupported in class Reader

See Also:

• Reader.markSupported()

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

See Also:

• Reader.read()

read

public int read(char[] cbuf,
 int offset,
 int length)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

See Also:

• Reader.read(char[], int, int)

read

public int read(char[] cbuf)
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

See Also:

• Reader.read(char[])

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException

See Also:

• Reader.ready()

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException

See Also:

• Reader.reset()

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class Reader

Throws:

IOException

See Also:

• Reader.skip(long)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException

See Also:

• Reader.close()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()