All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.jdom.Verifier

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

public final class Verifier
extends 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 Index

 o checkAttributeName(String)

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

 o checkCDATASection(String)

This will ensure that the data for a {

 o checkCharacterData(String)

This will check the supplied string to see if it only contains characters allowed by the XML 1.0 specification.

 o checkCommentData(String)

This will ensure that the data for a {

 o checkElementName(String)

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

 o checkNamespacePrefix(String)

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

 o checkNamespaceURI(String)

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

 o checkProcessingInstructionTarget(String)

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

 o isXMLCharacter(char)

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

 o isXMLCombiningChar(char)

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.

 o isXMLDigit(char)

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.

 o isXMLExtender(char)

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

 o isXMLLetter(char)

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

 o isXMLLetterOrDigit(char)

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.

 o isXMLNameCharacter(char)

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.

 o isXMLNameStartCharacter(char)

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.

 o main(String[])

Methods

 o checkElementName
 public static final String checkElementName(String name)

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

Parameters:
name - String name to check.
Returns:
String - reason name is invalid, or null if name is OK.
 o checkAttributeName
 public static final String checkAttributeName(String name)

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

Parameters:
name - String name to check.
Returns:
String - reason name is invalid, or null if name is OK.
 o checkCharacterData
 public static final String checkCharacterData(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 carriage 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.
 o checkCDATASection
 public static final String checkCDATASection(String data)

This will ensure that the data for a {@link CDATA} section is appropriate.

Parameters:
data - String data to check.
Returns:
String - reason data is invalid, or null is name is OK.
 o checkNamespacePrefix
 public static final String checkNamespacePrefix(String prefix)

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

Parameters:
prefix - String prefix to check.
Returns:
String - reason name is invalid, or null if name is OK.
 o checkNamespaceURI
 public static final String checkNamespaceURI(String uri)

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

Parameters:
uri - String URI to check.
Returns:
String - reason name is invalid, or null if name is OK.
 o checkProcessingInstructionTarget
 public static final String checkProcessingInstructionTarget(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.
 o checkCommentData
 public static final String checkCommentData(String data)

This will ensure that the data for a {@link Comment} is appropriate.

Parameters:
data - String data to check.
Returns:
String - reason data is invalid, or null is name is OK.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o main
 public static void main(String args[])

All Packages  Class Hierarchy  This Package  Previous  Next  Index