info.bliki.htmlcleaner

Class HtmlCleaner

java.lang.Object

info.bliki.htmlcleaner.HtmlCleaner

public class HtmlCleaner
extends Object

Main HtmlCleaner class.

It represents public interface to the user. It's task is to call tokenizer with specified source HTML, traverse list of produced token list and create internal object model. It also offers a set of methods to write resulting XML to string, file or any output stream.

Typical usage is the following:

HtmlCleaner cleaner = new HtmlCleaner(...); // one of few constructors cleaner.setXXX(...) // optionally, set cleaner's behaviour clener.clean(); // calls cleaning process cleaner.writeXmlXXX(...) // writes resulting XML to string, file or any output stream Created by: Vladimir Nikic
Date: November, 2006

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
HtmlCleaner(File file) Constructor - creates the instance for specified file and charset.
HtmlCleaner(File file, ITagInfoProvider tagInfoProvider) Constructor - creates the instance for specified file and charset.
HtmlCleaner(File file, String charset) Constructor - creates the instance for specified file.
HtmlCleaner(File file, String charset, ITagInfoProvider tagInfoProvider) Constructor - creates the instance for specified file.
HtmlCleaner(InputStream in) Constructor - creates the instance for the specified inpout stream
HtmlCleaner(InputStream in, ITagInfoProvider tagInfoProvider) Constructor - creates the instance for the specified inpout stream
HtmlCleaner(InputStream in, String charset) Constructor - creates the instance for the specified inpout stream and the charset
HtmlCleaner(String htmlContent) Constructor - creates the instance with specified html content as String.
HtmlCleaner(String htmlContent, ITagInfoProvider tagInfoProvider) Constructor - creates the instance with specified html content as String.
HtmlCleaner(URL url) Constructor - creates the instance for specified URL and charset.
HtmlCleaner(URL url, ITagInfoProvider tagInfoProvider) Constructor - creates the instance for specified URL and charset.
HtmlCleaner(URL url, String charset) Constructor - creates the instance for specified URL and charset.
HtmlCleaner(URL url, String charset, ITagInfoProvider tagInfoProvider) Constructor - creates the instance for specified URL and charset.

Method Summary

Modifier and Type	Method and Description
void	clean()
Set<String>	getAllTags()
TagNode	getBodyNode()
String	getCompactXmlAsString()
String	getHyphenReplacementInComment()
List<BaseToken>	getNodeList()
String	getPrettyXmlAsString()
String	getXmlAsString()
boolean	isAdvancedXmlEscape()
boolean	isOmitComments()
boolean	isOmitDeprecatedTags()
boolean	isOmitDoctypeDeclaration()
boolean	isOmitUnknownTags()
boolean	isOmitXmlDeclaration()
boolean	isOmitXmlnsAttributes()
boolean	isRecognizeUnicodeChars()
boolean	isTranslateSpecialEntities()
boolean	isUseCdataForScriptAndStyle()
void	setAdvancedXmlEscape(boolean advancedXmlEscape)
void	setBodyNode(TagNode bodyNode)
void	setHyphenReplacementInComment(String hyphenReplacementInComment)
void	setOmitComments(boolean omitComments)
void	setOmitDeprecatedTags(boolean omitDeprecatedTags)
void	setOmitDoctypeDeclaration(boolean omitDoctypeDeclaration)
void	setOmitUnknownTags(boolean omitUnknownTags)
void	setOmitXmlDeclaration(boolean omitXmlDeclaration)
void	setOmitXmlnsAttributes(boolean omitXmlnsAttributes)
void	setRecognizeUnicodeChars(boolean recognizeUnicodeChars)
void	setTranslateSpecialEntities(boolean translateSpecialEntities)
void	setUseCdataForScriptAndStyle(boolean useCdataForScriptAndStyle)
void	writeCompactXmlToFile(String fileName)
void	writeCompactXmlToFile(String fileName, String charset)
void	writeCompactXmlToStream(OutputStream out)
void	writeCompactXmlToStream(OutputStream out, String charset)
void	writePrettyXmlToFile(String fileName)
void	writePrettyXmlToFile(String fileName, String charset)
void	writePrettyXmlToStream(OutputStream out)
void	writePrettyXmlToStream(OutputStream out, String charset)
void	writeXml(XmlSerializer xmlSerializer) The most general way to serialize resulting XML.
void	writeXmlToFile(String fileName)
void	writeXmlToFile(String fileName, String charset)
void	writeXmlToStream(OutputStream out)
void	writeXmlToStream(OutputStream out, String charset)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

Constructor Detail

HtmlCleaner

public HtmlCleaner(String htmlContent,
                   ITagInfoProvider tagInfoProvider)

Constructor - creates the instance with specified html content as String.

Parameters:

htmlContent -

HtmlCleaner

public HtmlCleaner(String htmlContent)

Constructor - creates the instance with specified html content as String.

Parameters:

htmlContent -

HtmlCleaner

public HtmlCleaner(File file,
                   String charset,
                   ITagInfoProvider tagInfoProvider)
            throws IOException

Constructor - creates the instance for specified file.

Parameters:

file -

charset -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(File file,
                   String charset)
            throws IOException

Constructor - creates the instance for specified file.

Parameters:

file -

charset -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(File file,
                   ITagInfoProvider tagInfoProvider)
            throws IOException

Constructor - creates the instance for specified file and charset.

Parameters:

file -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(File file)
            throws IOException

Constructor - creates the instance for specified file and charset.

Parameters:

file -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(URL url,
                   String charset,
                   ITagInfoProvider tagInfoProvider)
            throws IOException

Constructor - creates the instance for specified URL and charset.

Parameters:

url -

charset -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(URL url,
                   ITagInfoProvider tagInfoProvider)
            throws IOException

Constructor - creates the instance for specified URL and charset.

Parameters:

url -

tagInfoProvider -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(URL url,
                   String charset)
            throws IOException

Constructor - creates the instance for specified URL and charset.

Parameters:

url -

charset -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(URL url)
            throws IOException

Constructor - creates the instance for specified URL and charset.

Parameters:

url -

Throws:

IOException

HtmlCleaner

public HtmlCleaner(InputStream in,
                   ITagInfoProvider tagInfoProvider)

Constructor - creates the instance for the specified inpout stream

Parameters:

in -

tagInfoProvider -

HtmlCleaner

public HtmlCleaner(InputStream in)

Constructor - creates the instance for the specified inpout stream

Parameters:

in -

HtmlCleaner

public HtmlCleaner(InputStream in,
                   String charset)
            throws IOException

Constructor - creates the instance for the specified inpout stream and the charset

Parameters:

in -

charset -

Throws:

IOException

Method Detail

clean

public void clean()
           throws IOException

Throws:

IOException

getNodeList

public List<BaseToken> getNodeList()
                            throws IOException

Throws:

IOException

isOmitUnknownTags

public boolean isOmitUnknownTags()

setOmitUnknownTags

public void setOmitUnknownTags(boolean omitUnknownTags)

isOmitDeprecatedTags

public boolean isOmitDeprecatedTags()

setOmitDeprecatedTags

public void setOmitDeprecatedTags(boolean omitDeprecatedTags)

isAdvancedXmlEscape

public boolean isAdvancedXmlEscape()

setAdvancedXmlEscape

public void setAdvancedXmlEscape(boolean advancedXmlEscape)

isUseCdataForScriptAndStyle

public boolean isUseCdataForScriptAndStyle()

setUseCdataForScriptAndStyle

public void setUseCdataForScriptAndStyle(boolean useCdataForScriptAndStyle)

isTranslateSpecialEntities

public boolean isTranslateSpecialEntities()

setTranslateSpecialEntities

public void setTranslateSpecialEntities(boolean translateSpecialEntities)

isRecognizeUnicodeChars

public boolean isRecognizeUnicodeChars()

setRecognizeUnicodeChars

public void setRecognizeUnicodeChars(boolean recognizeUnicodeChars)

isOmitComments

public boolean isOmitComments()

setOmitComments

public void setOmitComments(boolean omitComments)

isOmitXmlDeclaration

public boolean isOmitXmlDeclaration()

setOmitXmlDeclaration

public void setOmitXmlDeclaration(boolean omitXmlDeclaration)

isOmitDoctypeDeclaration

public boolean isOmitDoctypeDeclaration()

setOmitDoctypeDeclaration

public void setOmitDoctypeDeclaration(boolean omitDoctypeDeclaration)

isOmitXmlnsAttributes

public boolean isOmitXmlnsAttributes()

setOmitXmlnsAttributes

public void setOmitXmlnsAttributes(boolean omitXmlnsAttributes)

getHyphenReplacementInComment

public String getHyphenReplacementInComment()

setHyphenReplacementInComment

public void setHyphenReplacementInComment(String hyphenReplacementInComment)

getAllTags

public Set<String> getAllTags()

writeXml

public void writeXml(XmlSerializer xmlSerializer)
              throws IOException

The most general way to serialize resulting XML.

Parameters:

xmlSerializer -

Throws:

IOException

writeXmlToStream

public void writeXmlToStream(OutputStream out)
                      throws IOException

Throws:

IOException

writeXmlToStream

public void writeXmlToStream(OutputStream out,
                             String charset)
                      throws IOException

Throws:

IOException

writeCompactXmlToStream

public void writeCompactXmlToStream(OutputStream out)
                             throws IOException

Throws:

IOException

writeCompactXmlToStream

public void writeCompactXmlToStream(OutputStream out,
                                    String charset)
                             throws IOException

Throws:

IOException

writePrettyXmlToStream

public void writePrettyXmlToStream(OutputStream out)
                            throws IOException

Throws:

IOException

writePrettyXmlToStream

public void writePrettyXmlToStream(OutputStream out,
                                   String charset)
                            throws IOException

Throws:

IOException

writeXmlToFile

public void writeXmlToFile(String fileName)
                    throws IOException

Throws:

IOException

writeXmlToFile

public void writeXmlToFile(String fileName,
                           String charset)
                    throws IOException

Throws:

IOException

writeCompactXmlToFile

public void writeCompactXmlToFile(String fileName)
                           throws IOException

Throws:

IOException

writeCompactXmlToFile

public void writeCompactXmlToFile(String fileName,
                                  String charset)
                           throws IOException

Throws:

IOException

writePrettyXmlToFile

public void writePrettyXmlToFile(String fileName)
                          throws IOException

Throws:

IOException

writePrettyXmlToFile

public void writePrettyXmlToFile(String fileName,
                                 String charset)
                          throws IOException

Throws:

IOException

getXmlAsString

public String getXmlAsString()
                      throws IOException

Throws:

IOException

getCompactXmlAsString

public String getCompactXmlAsString()
                             throws IOException

Throws:

IOException

getPrettyXmlAsString

public String getPrettyXmlAsString()
                            throws IOException

Throws:

IOException

getBodyNode

public TagNode getBodyNode()

setBodyNode

public void setBodyNode(TagNode bodyNode)