org::jdom::Verifier Class Reference

List of all members.

Static Public Member Functions

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

Detailed Description

Verifier handles XML checks on names, data, and other verification tasks for JDOM. The class is final and may not be subclassed.

Author:
Brett McLaughlin

Elliotte Rusty Harold

Jason Hunter

Bradley S. Huffman

Version:
Revision
1.44
,
Date
2003/04/14 19:24:40


Member Function Documentation

static String org::jdom::Verifier::checkElementName ( String  name  )  [inline, static]

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

Parameters:
name String name to check.
Returns:
String - reason name is illegal, or null if name is OK.

static String org::jdom::Verifier::checkAttributeName ( String  name  )  [inline, static]

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

Parameters:
name String name to check.
Returns:
String - reason name is illegal, or null if name is OK.

static String org::jdom::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:
text String value to check.
Returns:
String - reason name is illegal, or null if name is OK.

static String org::jdom::Verifier::checkCDATASection ( String  data  )  [inline, static]

This will check the supplied data to see if it is legal for use as JDOM CDATA.

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

static String org::jdom::Verifier::checkNamespacePrefix ( String  prefix  )  [inline, static]

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

Parameters:
prefix String prefix to check.
Returns:
String - reason name is illegal, or null if name is OK.

static String org::jdom::Verifier::checkNamespaceURI ( String  uri  )  [inline, static]

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

Parameters:
uri String URI to check.
Returns:
String - reason name is illegal, or null if name is OK.

static String org::jdom::Verifier::checkNamespaceCollision ( Namespace  namespace,
Namespace  other 
) [inline, static]

Check if two namespaces collide.

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

static String org::jdom::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 against.
Returns:
String - reason for collision, or null if no collision.

static String org::jdom::Verifier::checkNamespaceCollision ( Namespace  namespace,
Element  element 
) [inline, static]

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

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

static String org::jdom::Verifier::checkNamespaceCollision ( Namespace  namespace,
Attribute  attribute 
) [inline, static]

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

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

static String org::jdom::Verifier::checkNamespaceCollision ( Namespace  namespace,
List  list 
) [inline, static]

Check if a Namespace collides with any namespace from a list of objects.

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

static String org::jdom::Verifier::checkProcessingInstructionTarget ( String  target  )  [inline, static]

This will check the supplied data to see if it is legal for use as a JDOM ProcessingInstruction target.

Parameters:
target String target to check.
Returns:
String - reason target is illegal, or null if target is OK.

static String org::jdom::Verifier::checkProcessingInstructionData ( String  data  )  [inline, static]

This will check the supplied data to see if it is legal for use as ProcessingInstruction data. Besides checking that all the characters are allowed in XML, this also checks that the data does not contain the PI end-string "?&gt;".

Parameters:
data String data to check.
Returns:
String - reason data is illegal, or null if data is OK.

static String org::jdom::Verifier::checkCommentData ( String  data  )  [inline, static]

This will check the supplied data to see if it is legal for use as JDOM Comment data.

Parameters:
data String data to check.
Returns:
String - reason data is illegal, or null if data is OK.

static String org::jdom::Verifier::checkPublicID ( String  publicID  )  [inline, static]

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

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

static String org::jdom::Verifier::checkSystemLiteral ( String  systemLiteral  )  [inline, static]

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

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

static String org::jdom::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 illegal, or null if OK.

static boolean org::jdom::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.

static boolean org::jdom::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.

static boolean org::jdom::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.

static boolean org::jdom::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.

static boolean org::jdom::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.

static boolean org::jdom::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.

static boolean org::jdom::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.

static boolean org::jdom::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.


The documentation for this class was generated from the following file:
Generated on Sat Nov 11 01:47:12 2006 for JDOM by  doxygen 1.5.1