org.jdom
Class Verifier

java.lang.Object
  |
  +--org.jdom.Verifier

public final class Verifier

extends java.lang.Object

Verifier handles XML checks on names, data, and other verification tasks for JDOM.

Version:

1.0

Author:

Brett McLaughlin, Elliotte Rusty Harold, Jason Hunter

Method Summary

static java.lang.String	checkAttributeName(java.lang.String name) This will check the supplied name to see if it valid for use as a JDOM Attribute name.
static java.lang.String	checkCharacterData(java.lang.String text) This will check the supplied string to see if it only contains characters allowed by the XML 1.0 specification.
static java.lang.String	checkCommentData(java.lang.String data) This will ensure that the data for a Comment is appropriate.
static java.lang.String	checkElementName(java.lang.String name) This will check the supplied name to see if it valid for use as a JDOM Element name.
static java.lang.String	checkNamespacePrefix(java.lang.String prefix) This will check the supplied name to see if it valid for use as a JDOM Namespace prefix.
static java.lang.String	checkNamespaceURI(java.lang.String uri) This will check the supplied name to see if it valid for use as a JDOM Namespace URI.
static java.lang.String	checkProcessingInstructionTarget(java.lang.String target) This will check the supplied name to see if it valid for use as a JDOM processing instruction target.
static boolean	isXMLCharacter(char c) This is a utility function for determining whether a specified character is a character according to production 2 of the XML 1.0 specification.
static boolean	isXMLCombiningChar(char c) This is a utility function for determining whether a specified character is a combining character according to production 87 of the XML 1.0 specification.
static boolean	isXMLDigit(char c) This is a utility function for determining whether a specified Unicode character is a digit according to production 88 of the XML 1.0 specification.
static boolean	isXMLExtender(char c) This is a utility function for determining whether a specified character is an extender according to production 88 of the XML 1.0 specification.
static boolean	isXMLLetter(char c) This is a utility function for determining whether a specified character is a letter according to production 84 of the XML 1.0 specification.
static boolean	isXMLLetterOrDigit(char c) This is a utility function for determining whether a specified character is a letter or digit according to productions 84 and 88 of the XML 1.0 specification.
static boolean	isXMLNameCharacter(char c) This is a utility function for determining whether a specified character is a name character according to production 4 of the XML 1.0 specification.
static boolean	isXMLNameStartCharacter(char c) This is a utility function for determining whether a specified character is a legal name start character according to production 5 of the XML 1.0 specification.

Methods inherited from class java.lang.Object

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

Method Detail

checkElementName

public static final java.lang.String checkElementName(java.lang.String name)

This will check the supplied name to see if it valid for use as a JDOM Element name.

Parameters:

name - String name to check.

Returns:

String - reason name is invalid, or null if name is OK.

checkAttributeName

public static final java.lang.String checkAttributeName(java.lang.String name)

This will check the supplied name to see if it valid for use as a JDOM Attribute name.

Parameters:

name - String name to check.

Returns:

String - reason name is invalid, or null if name is OK.

checkCharacterData

public static final java.lang.String checkCharacterData(java.lang.String text)

This will check the supplied string to see if it only contains characters allowed by the XML 1.0 specification. The C0 controls (e.g. null, vertical tab, formfeed, etc.) are specifically excluded except for carirage return, linefeed, and the horizontal tab. Surrogates are also excluded.

This method is useful for checking element content and attribute values. Note that characters like " and < are allowed in attribute values and element content. They will simply be escaped as " or < when the value is serialized.

Parameters:

name - String value to check.

Returns:

String - reason name is invalid, or null if name is OK.

checkNamespacePrefix

public static final java.lang.String checkNamespacePrefix(java.lang.String prefix)

This will check the supplied name to see if it valid for use as a JDOM Namespace prefix.

Parameters:

prefix - String prefix to check.

Returns:

String - reason name is invalid, or null if name is OK.

checkNamespaceURI

public static final java.lang.String checkNamespaceURI(java.lang.String uri)

This will check the supplied name to see if it valid for use as a JDOM Namespace URI.

Parameters:

uri - String URI to check.

Returns:

String - reason name is invalid, or null if name is OK.

checkProcessingInstructionTarget

public static final java.lang.String checkProcessingInstructionTarget(java.lang.String target)

This will check the supplied name to see if it valid for use as a JDOM processing instruction target.

Parameters:

target - String target to check.

Returns:

String - reason target is invalid, or null if name is OK.

checkCommentData

public static final java.lang.String checkCommentData(java.lang.String data)

This will ensure that the data for a Comment is appropriate.

Parameters:

data - String data to check.

Returns:

String - reason data is invalid, or null is name is OK.

isXMLCharacter

public static boolean isXMLCharacter(char c)

This is a utility function for determining whether a specified character is a character according to production 2 of the XML 1.0 specification.

Parameters:

c - char to check for XML compliance.

Returns:

boolean - true if it's a character, false otherwise.

isXMLNameCharacter

public static boolean isXMLNameCharacter(char c)

This is a utility function for determining whether a specified character is a name character according to production 4 of the XML 1.0 specification.

Parameters:

c - char to check for XML name compliance.

Returns:

boolean - true if it's a name character, false otherwise.

isXMLNameStartCharacter

public static boolean isXMLNameStartCharacter(char c)

This is a utility function for determining whether a specified character is a legal name start character according to production 5 of the XML 1.0 specification. This production does allow names to begin with colons which the Namespaces in XML Recommendation disallows.

Parameters:

c - char to check for XML name start compliance.

Returns:

boolean - true if it's a name start character, false otherwise.

isXMLLetterOrDigit

public static boolean isXMLLetterOrDigit(char c)

This is a utility function for determining whether a specified character is a letter or digit according to productions 84 and 88 of the XML 1.0 specification.

Parameters:

c - char to check.

Returns:

boolean - true if it's letter or digit, false otherwise.

isXMLLetter

public static boolean isXMLLetter(char c)

This is a utility function for determining whether a specified character is a letter according to production 84 of the XML 1.0 specification.

Parameters:

c - char to check for XML name compliance.

Returns:

String - true if it's a letter, false otherwise.

isXMLCombiningChar

public static boolean isXMLCombiningChar(char c)

This is a utility function for determining whether a specified character is a combining character according to production 87 of the XML 1.0 specification.

Parameters:

c - char to check.

Returns:

boolean - true if it's a combining character, false otherwise.

isXMLExtender

public static boolean isXMLExtender(char c)

This is a utility function for determining whether a specified character is an extender according to production 88 of the XML 1.0 specification.

Parameters:

c - char to check.

Returns:

String - true if it's an extender, false otherwise.

isXMLDigit

public static boolean isXMLDigit(char c)

This is a utility function for determining whether a specified Unicode character is a digit according to production 88 of the XML 1.0 specification.

Parameters:

c - char to check for XML digit compliance.

Returns:

boolean - true if it's a digit, false otherwise.