com.phloc.commons.xml.serialize

Class HTMLdtd

java.lang.Object

com.phloc.commons.xml.serialize.HTMLdtd

public final class HTMLdtd
extends Object

Utility class for accessing information specific to HTML documents. The HTML DTD is expressed as three utility function groups. Two methods allow for checking whether an element requires an open tag on printing ( isEmptyTag(java.lang.String)) or on parsing (isOptionalClosing(java.lang.String)).

Two other methods translate character references from name to value and from value to name. A small entities resource is loaded into memory the first time any of these methods is called for fast and efficient access.

Version:

$Revision: 699892 $ $Date: 2008-09-28 17:08:27 -0400 (Sun, 28 Sep 2008) $

Author:

Assaf Arkin

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isBoolean(String sTagName, String sAttrName) Returns true if the specified attribute is a boolean and should be printed without the value.
static boolean	isClosing(String sTagName, String sOpenTagName) Returns true if the opening of one element (sTagName) implies the closing of another open element (openTag).
static boolean	isElementContent(String sTagName) Returns true if element is declared to have element content.
static boolean	isEmptyTag(String sTagName) Returns true if element is declared to be empty.
static boolean	isOnlyOpening(String sTagName) Returns true if element's closing tag is generally not printed.
static boolean	isOptionalClosing(String sTagName) Returns true if element's closing tag is optional and need not exist.
static boolean	isPreserveSpace(String sTagName) Returns true if element's textual contents preserves spaces.
static boolean	isURI(String sTagName, String sAttrName) Returns true if the specified attribute it a URI and should be escaped appropriately.

Methods inherited from class java.lang.Object

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

Method Detail

isEmptyTag

public static boolean isEmptyTag(@Nonnull
                 String sTagName)

Returns true if element is declared to be empty. HTML elements are defines as empty in the DTD, not by the document syntax.

Parameters:

sTagName - The element tag name (upper case)

Returns:

True if element is empty

isElementContent

public static boolean isElementContent(@Nonnull
                       String sTagName)

Returns true if element is declared to have element content. Whitespaces appearing inside element content will be ignored, other text will simply report an error.

Parameters:

sTagName - The element tag name (upper case)

Returns:

True if element content

isPreserveSpace

public static boolean isPreserveSpace(@Nonnull
                      String sTagName)

Returns true if element's textual contents preserves spaces. This only applies to PRE and TEXTAREA, all other HTML elements do not preserve space.

Parameters:

sTagName - The element tag name (upper case)

Returns:

True if element's text content preserves spaces

isOptionalClosing

public static boolean isOptionalClosing(@Nonnull
                        String sTagName)

Returns true if element's closing tag is optional and need not exist. An error will not be reported for such elements if they are not closed. For example, LI is most often not closed.

Parameters:

sTagName - The element tag name (upper case)

Returns:

True if closing tag implied

isOnlyOpening

public static boolean isOnlyOpening(@Nonnull
                    String sTagName)

Returns true if element's closing tag is generally not printed. For example, LI should not print the closing tag.

Parameters:

sTagName - The element tag name (upper case)

Returns:

True if only opening tag should be printed

isClosing

public static boolean isClosing(@Nonnull
                String sTagName,
                @Nonnull
                String sOpenTagName)

Returns true if the opening of one element (sTagName) implies the closing of another open element (openTag). For example, every opening LI will close the previously open LI, and every opening BODY will close the previously open HEAD.

Parameters:

sTagName - The newly opened element

sOpenTagName - The already opened element

Returns:

True if closing tag closes opening tag

isURI

public static boolean isURI(@Nonnull
            String sTagName,
            @Nonnull
            String sAttrName)

Returns true if the specified attribute it a URI and should be escaped appropriately. In HTML URIs are escaped differently than normal attributes.

Parameters:

sTagName - The element's tag name

sAttrName - The attribute's name

Returns:

true if the passed combination is an URI attribute

isBoolean

public static boolean isBoolean(@Nonnull
                String sTagName,
                @Nonnull
                String sAttrName)

Returns true if the specified attribute is a boolean and should be printed without the value. This applies to attributes that are true if they exist, such as selected (OPTION/INPUT).

Parameters:

sTagName - The element's tag name

sAttrName - The attribute's name

Returns:

true if the passed combination is a boolean value