Module org.apache.wicket.util

Package org.apache.wicket.util.io

Class XmlReader

java.lang.Object

java.io.Reader

org.apache.wicket.util.io.XmlReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class XmlReader
extends Reader

This is a simple XmlReader. Its only purpose is to read the xml decl string from the input and apply proper character encoding to all subsequent characters. The xml decl string itself is removed from the output.

Author:

Juergen Donnerstag

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor	Description
XmlReader(InputStream inputStream, String defaultEncoding)	Construct.

Method Summary

Modifier and Type	Method	Description
void	close()
String	getEncoding()	Return the encoding used while reading the markup file.
void	init()	Reads and parses markup from a resource such as file.
int	read(char[] buf, int from, int to)
String	toString()

Methods inherited from class java.io.Reader

mark, markSupported, nullReader, read, read, read, ready, reset, skip, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XmlReader

public XmlReader(InputStream inputStream,
                 String defaultEncoding)
          throws IOException

Construct.

Parameters:

inputStream - The InputStream to read the xml data from

defaultEncoding - Default character encoding to use when not specified in XML declaration, specify null to use JVM default

Throws:

IOException - In case something went wrong while reading the data

Method Detail

getEncoding

public final String getEncoding()

Return the encoding used while reading the markup file.

Returns:

if null, then JVM default

init

public void init()
          throws IOException

Reads and parses markup from a resource such as file.

Throws:

IOException

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()

read

public int read(char[] buf,
                int from,
                int to)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

See Also:

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

toString

public String toString()

Overrides:

toString in class Object

Returns:

The markup to be parsed