Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

Verifier Class Reference

List of all members.

Static Public Methods

final String checkElementName (String name)
final String checkAttributeName (String name)
final String checkCharacterData (String text)
final String checkCDATASection (String data)
final String checkNamespacePrefix (String prefix)
final String checkNamespaceURI (String uri)
final String checkNamespaceCollision (Namespace namespace, Namespace other)
final String checkNamespaceCollision (Attribute attribute, Element element)
final String checkNamespaceCollision (Namespace namespace, Element element)
final String checkNamespaceCollision (Namespace namespace, Attribute attribute)
final String checkNamespaceCollision (Namespace namespace, List list)
final String checkProcessingInstructionTarget (String target)
final String checkCommentData (String data)
final String checkPublicID (String publicID)
final String checkSystemLiteral (String systemLiteral)
String checkXMLName (String name)
boolean isXMLCharacter (char c)
boolean isXMLNameCharacter (char c)
boolean isXMLNameStartCharacter (char c)
boolean isXMLLetterOrDigit (char c)
boolean isXMLLetter (char c)
boolean isXMLCombiningChar (char c)
boolean isXMLExtender (char c)
boolean isXMLDigit (char c)
void main (String[] args)

Detailed Description

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

Author:
Brett McLaughlin , Elliotte Rusty Harold , Jason Hunter , Bradley S. Huffman
Version:
Revision:
1.29
,
Date:
2002/02/08 05:40:56


Member Function Documentation

final String Verifier::checkAttributeName String    name [inline, static]
 

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.

final String Verifier::checkCDATASection String    data [inline, static]
 

This will ensure that the data for a CDATA section is appropriate.

Parameters:
data  String data to check.
Returns:
String - reason data is invalid, or null is name is OK.

final String Verifier::checkCharacterData String    text [inline, static]
 

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.

final String Verifier::checkCommentData String    data [inline, static]
 

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 if data is OK.

final String Verifier::checkElementName String    name [inline, static]
 

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.

final String Verifier::checkNamespaceCollision Namespace    namespace,
List    list
[inline, static]
 

Check if namespace collides with any object's namespace from a list of objects.

Parameters:
namespace  Namespace to check.
list  List to check agianst.
Returns:
String - reason for collision, or null if no collision.

final String Verifier::checkNamespaceCollision Namespace    namespace,
Attribute    attribute
[inline, static]
 

Check if namespace collides with a Attribute's namespace.

Parameters:
namespace  Namespace to check.
attribute  Attribute to check agianst.
Returns:
String - reason for collision, or null if no collision.

final String Verifier::checkNamespaceCollision Namespace    namespace,
Element    element
[inline, static]
 

Check if namespace collides with a Element's namespace.

Parameters:
namespace  Namespace to check.
element  Element to check agianst.
Returns:
String - reason for collision, or null if no collision.

final String Verifier::checkNamespaceCollision Attribute    attribute,
Element    element
[inline, static]
 

Check if Attribute's namespace collides with a Element's namespace.

Parameters:
attribute  Attribute to check.
element  Element to check agianst.
Returns:
String - reason for collision, or null if no collision.

final String Verifier::checkNamespaceCollision Namespace    namespace,
Namespace    other
[inline, static]
 

Check if two namespaces collide.

Parameters:
namespace  Namespace to check.
other  Namespace to check agianst.
Returns:
String - reason for collision, or null if no collision.

final String Verifier::checkNamespacePrefix String    prefix [inline, static]
 

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.

final String Verifier::checkNamespaceURI String    uri [inline, static]
 

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.

final String Verifier::checkProcessingInstructionTarget String    target [inline, static]
 

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.

final String Verifier::checkPublicID String    publicID [inline, static]
 

This will ensure that the data for a public identifier is appropriate.

Parameters:
publicID  String public ID to check.
Returns:
String - reason public ID is invalid, or null if public ID is OK.

final String Verifier::checkSystemLiteral String    systemLiteral [inline, static]
 

This will ensure that the data for a system literal is appropriate.

Parameters:
systemLiteral  String system literal to check.
Returns:
String - reason system literal is invalid, or null if system literal is OK.

String Verifier::checkXMLName String    name [inline, static]
 

This is a utility function for sharing the base process of checking any XML name.

Parameters:
name  String to check for XML name compliance.
Returns:
String - reason the name is invalid, or null if OK.

boolean Verifier::isXMLCharacter char    c [inline, static]
 

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.

boolean Verifier::isXMLCombiningChar char    c [inline, static]
 

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.

boolean Verifier::isXMLDigit char    c [inline, static]
 

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.

boolean Verifier::isXMLExtender char    c [inline, static]
 

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.

boolean Verifier::isXMLLetter char    c [inline, static]
 

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.

boolean Verifier::isXMLLetterOrDigit char    c [inline, static]
 

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.

boolean Verifier::isXMLNameCharacter char    c [inline, static]
 

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.

boolean Verifier::isXMLNameStartCharacter char    c [inline, static]
 

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.


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:04 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001