org.attoparser.markup
Class DocumentRestrictions

Object
  org.attoparser.markup.DocumentRestrictions

All Implemented Interfaces:

Serializable

public final class DocumentRestrictions
extends Object
implements Serializable

Models a series of restrictions that can be applied during document parsing by subclasses of AbstractDetailedMarkupAttoHandler.

A fixed set of these restrictions can be used for checking the well-formedness (from an XML/XHTML standpoint) of a document:

• requireBalancedElements: Elements are correctly nested, and no open element lacks its corresponding close element.
• requireUniqueRootElement: Require the existance of only one element at root level.
• requireWellFormedProlog: Document prolog is well-formed: only one optional XML Declaration, followed by only one optional DOCTYPE clause, followed by only one required root element (with any number of comments among them).
• requireWellFormedAttributeValues: All attribute values must have an equals sign (=) and must be surrounded by commas (double or single).
• requireUniqueAttributesInElement: No element can have repeated attributes.

Besides these well-formedness related restrictions, there is also a requireNoProlog restriction that ensures no XML Declaration or DOCTYPE clause appears in the parsed document.

Since:

1.0

Author:

Daniel Fernández

See Also:

Serialized Form

Method Summary

boolean	getRequireBalancedElements()
boolean	getRequireNoProlog()
boolean	getRequireUniqueAttributesInElement()
boolean	getRequireUniqueRootElement()
boolean	getRequireWellFormedAttributeValues()
boolean	getRequireWellFormedProlog()
static DocumentRestrictions	none() Creates a DocumentRestrictions instance enforcing no restrictions at all.
void	setRequireBalancedElements(boolean requireBalancedElements)
void	setRequireNoProlog(boolean requireNoProlog)
void	setRequireUniqueAttributesInElement(boolean requireUniqueAttributesInElement)
void	setRequireUniqueRootElement(boolean requireUniqueRootElement)
void	setRequireWellFormedAttributeValues(boolean requireWellFormedAttributeValues)
void	setRequireWellFormedProlog(boolean requireWellFormedProlog)
static DocumentRestrictions	wellFormed() Creates a DocumentRestrictions instance enforcing the set of restrictions that check the well-formedness (from an XML/XHTML standpoint): requireBalancedElements, requireWellFormedProlog, requireUniqueRootElement, requireWellFormedAttributeValues and requireUniqueAttributesInElement.

Methods inherited from class Object

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

Method Detail

none

public static DocumentRestrictions none()

Creates a DocumentRestrictions instance enforcing no restrictions at all.

Returns:

the new instance.

wellFormed

public static DocumentRestrictions wellFormed()

Creates a DocumentRestrictions instance enforcing the set of restrictions that check the well-formedness (from an XML/XHTML standpoint): requireBalancedElements, requireWellFormedProlog, requireUniqueRootElement, requireWellFormedAttributeValues and requireUniqueAttributesInElement.

Returns:

the new instance.

getRequireBalancedElements

public boolean getRequireBalancedElements()

setRequireBalancedElements

public void setRequireBalancedElements(boolean requireBalancedElements)

getRequireWellFormedProlog

public boolean getRequireWellFormedProlog()

setRequireWellFormedProlog

public void setRequireWellFormedProlog(boolean requireWellFormedProlog)

getRequireWellFormedAttributeValues

public boolean getRequireWellFormedAttributeValues()

setRequireWellFormedAttributeValues

public void setRequireWellFormedAttributeValues(boolean requireWellFormedAttributeValues)

getRequireUniqueAttributesInElement

public boolean getRequireUniqueAttributesInElement()

setRequireUniqueAttributesInElement

public void setRequireUniqueAttributesInElement(boolean requireUniqueAttributesInElement)

getRequireUniqueRootElement

public boolean getRequireUniqueRootElement()

setRequireUniqueRootElement

public void setRequireUniqueRootElement(boolean requireUniqueRootElement)

getRequireNoProlog

public boolean getRequireNoProlog()

setRequireNoProlog

public void setRequireNoProlog(boolean requireNoProlog)