com.taursys.dom
Class TidyDocumentAdapterBuilder

java.lang.Object
  com.taursys.dom.DocumentAdapterBuilder
      com.taursys.dom.TidyDocumentAdapterBuilder

public class TidyDocumentAdapterBuilder

extends DocumentAdapterBuilder

TidyDocumentAdapterBuilder is used to create a DOM_2_20001113_DocumentAdapter. It provides a variety of build methods with options to validate the document source. It uses the JTidy 04Aug2000r7-dev DOMParser to create the DocumentAdapter.

Version:

$Revision: 1.2 $

Author:

marty

Field Summary

static java.lang.String	FEATURE_CORRECT_COMMENTS
static java.lang.String	FEATURE_INDENT_DOCUMENT
static java.lang.String	FEATURE_ONLY_ERRORS
static java.lang.String	FEATURE_QUIET
static java.lang.String	FEATURE_TIDY_MARK
static java.lang.String	PROPERTY_ERROR_OUT

Fields inherited from class com.taursys.dom.DocumentAdapterBuilder

MESSAGE_NULL_INPUT_STREAM

Constructor Summary

TidyDocumentAdapterBuilder()
Constructs new builder with FEATURE_TIDY_MARK set false, FEATURE_CORRECT_COMMENTS set true and PROPERTY_ERROR_OUT set to a dummy print stream.

Method Summary

DocumentAdapter	build(java.io.InputStream is) Build a new DocumentAdapter from the XML document contained in the InputStream.
java.io.PrintWriter	getErrout()
boolean	getFeature(java.lang.String featureName) Returns true if given featureName is enables, otherwise false See the Specific DocumentAdapterBuilder, DocumentBuilder and/or Parser for the specific Features and Properties.
java.lang.Object	getProperty(java.lang.String propertyName) Gets the given property.
boolean	isCorrectComments()
boolean	isIndentDocument()
boolean	isOnlyErrors()
boolean	isQuiet()
boolean	isTidyMark()
void	setCorrectComments(boolean correctComments)
void	setErrout(java.io.PrintWriter arg0)
void	setFeature(java.lang.String featureName, boolean value) Enables the given featureName if value is true, otherwise disables feature.
void	setIndentDocument(boolean indentDocument)
void	setOnlyErrors(boolean arg0)
void	setProperty(java.lang.String propertyName, java.lang.Object value) Sets the given property to the given value.
void	setQuiet(boolean arg0)
void	setTidyMark(boolean arg0)

Methods inherited from class com.taursys.dom.DocumentAdapterBuilder

build, build, build, build

Methods inherited from class java.lang.Object

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

Field Detail

FEATURE_CORRECT_COMMENTS

public static final java.lang.String FEATURE_CORRECT_COMMENTS

See Also:

Constant Field Values

FEATURE_INDENT_DOCUMENT

public static final java.lang.String FEATURE_INDENT_DOCUMENT

See Also:

Constant Field Values

FEATURE_ONLY_ERRORS

public static final java.lang.String FEATURE_ONLY_ERRORS

See Also:

Constant Field Values

FEATURE_QUIET

public static final java.lang.String FEATURE_QUIET

See Also:

Constant Field Values

FEATURE_TIDY_MARK

public static final java.lang.String FEATURE_TIDY_MARK

See Also:

Constant Field Values

PROPERTY_ERROR_OUT

public static final java.lang.String PROPERTY_ERROR_OUT

See Also:

Constant Field Values

Constructor Detail

TidyDocumentAdapterBuilder

public TidyDocumentAdapterBuilder()

Constructs new builder with FEATURE_TIDY_MARK set false, FEATURE_CORRECT_COMMENTS set true and PROPERTY_ERROR_OUT set to a dummy print stream.

Method Detail

setFeature

public void setFeature(java.lang.String featureName,
                       boolean value)

Description copied from class: DocumentAdapterBuilder

Enables the given featureName if value is true, otherwise disables feature. See the Specific DocumentAdapterBuilder, DocumentBuilder and/or Parser for the specific Features and Properties.

Specified by:

setFeature in class DocumentAdapterBuilder

Parameters:

featureName - to enable/disable

value - true to enable, false to disable

getFeature

public boolean getFeature(java.lang.String featureName)

Description copied from class: DocumentAdapterBuilder

Returns true if given featureName is enables, otherwise false See the Specific DocumentAdapterBuilder, DocumentBuilder and/or Parser for the specific Features and Properties.

Specified by:

getFeature in class DocumentAdapterBuilder

Parameters:

featureName - to query

Returns:

true if enabled, otherwise false

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object value)

Description copied from class: DocumentAdapterBuilder

Sets the given property to the given value. See the Specific DocumentAdapterBuilder, DocumentBuilder and/or Parser for the specific Features and Properties.

Specified by:

setProperty in class DocumentAdapterBuilder

Parameters:

propertyName - name of the property to set

value - for the property

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Description copied from class: DocumentAdapterBuilder

Gets the given property. See the Specific DocumentAdapterBuilder, DocumentBuilder and/or Parser for the specific Features and Properties.

Specified by:

getProperty in class DocumentAdapterBuilder

Parameters:

propertyName - to retrieve

Returns:

value of property

build

public DocumentAdapter build(java.io.InputStream is)
                      throws DocumentAdapterBuilderException

Description copied from class: DocumentAdapterBuilder

Build a new DocumentAdapter from the XML document contained in the InputStream.

Specified by:

build in class DocumentAdapterBuilder

Parameters:

is - InputStream containing the XML source document

Returns:

a new DocumentAdapter

Throws:

DocumentAdapterBuilderException - if invalid parameters or problems parsing the document.

isCorrectComments

public boolean isCorrectComments()

setCorrectComments

public void setCorrectComments(boolean correctComments)

isIndentDocument

public boolean isIndentDocument()

setIndentDocument

public void setIndentDocument(boolean indentDocument)

isOnlyErrors

public boolean isOnlyErrors()

isQuiet

public boolean isQuiet()

isTidyMark

public boolean isTidyMark()

setOnlyErrors

public void setOnlyErrors(boolean arg0)

setQuiet

public void setQuiet(boolean arg0)

setTidyMark

public void setTidyMark(boolean arg0)

getErrout

public java.io.PrintWriter getErrout()

setErrout

public void setErrout(java.io.PrintWriter arg0)