com.sapportals.wcm.util.html

Class HTMLInputStream

java.lang.Object
  java.io.InputStream
      com.sapportals.wcm.util.html.HTMLInputStream

All Implemented Interfaces:

Closeable

public class HTMLInputStream
extends InputStream

A InputStream on top of a IHTMLReader.

Allows to treat a reader as an InputStream. The reader can be a IHTMLFilter allowing a HTML document to be processed in a streaming manner.

Characters from the reader are converted to bytes either by using the encoding of the reader (e.g. the encoding of the original documnet) or by specifying an encoding explicitly.

Copyright (c) SAP AG 2001-2002

Constructor Summary

HTMLInputStream(IHTMLReader reader)
An InputStream with reader as HTML source.

HTMLInputStream(IHTMLReader reader, String encoding)
An InputStream with reader as HTML source.

Method Summary

void	close()
String	getEncoding() Returns the character encoding used by this input stream.
int	read()
int	read(byte[] buffer, int offset, int len)

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLInputStream

public HTMLInputStream(IHTMLReader reader)
                throws UnsupportedEncodingException,
                       HTMLException,
                       IOException

An InputStream with reader as HTML source. The charcters are encoded using the reader's encoding.

Parameters:

reader - to read the HTML document from

Throws:

UnsupportedEncodingException - Exception raised in failure situation

HTMLException - Exception raised in failure situation

IOException - Exception raised in failure situation

HTMLInputStream

public HTMLInputStream(IHTMLReader reader,
                       String encoding)
                throws UnsupportedEncodingException

An InputStream with reader as HTML source. The charcters are encoded in the given encoding. If encoding is null , the default system encoding is used.

Parameters:

reader - to read the HTML document from

encoding - to use (null for default system encoding)

Throws:

UnsupportedEncodingException - Exception raised in failure situation

Method Detail

getEncoding

public String getEncoding()

Returns the character encoding used by this input stream. When encoding is null , the default system encoding is used.

Returns:

encoding used by this input stream for the HTML characters.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buffer,
                int offset,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM