public class

XML11Char

extends Object
java.lang.Object
   ↳ org.apache.xerces.util.XML11Char

Class Overview

This class defines the basic properties of characters in XML 1.1. The data in this class can be used to verify that a character is a valid XML 1.1 character or if the character is a space, name start, or name character.

A series of convenience methods are supplied to ease the burden of the developer. Using the character as an index into the XML11CHARS array and applying the appropriate mask flag (e.g. MASK_VALID), yields the same results as calling the convenience methods. There is one exception: check the comments for the isValid method for details.

Summary

Constants
int MASK_XML11_CONTENT XML 1.1 content for external entities (valid - "special" chars - control chars)
int MASK_XML11_CONTENT_INTERNAL XML 1.1 content for internal entities (valid - "special" chars)
int MASK_XML11_CONTROL XML 1.1 control character mask
int MASK_XML11_NAME XML 1.1 Name character mask.
int MASK_XML11_NAME_START XML 1.1 Name start character mask.
int MASK_XML11_NCNAME XML namespaces 1.1 NCName
int MASK_XML11_NCNAME_START XML namespaces 1.1 NCNameStart
int MASK_XML11_SPACE XML 1.1 Space character mask.
int MASK_XML11_VALID XML 1.1 Valid character mask.
Public Constructors
XML11Char()
Public Methods
static boolean isXML11Content(int c)
Returns true if the specified character can be considered content in an external parsed entity.
static boolean isXML11InternalEntityContent(int c)
Returns true if the specified character can be considered content in an internal parsed entity.
static boolean isXML11Invalid(int c)
Returns true if the specified character is invalid.
static boolean isXML11NCName(int c)
Returns true if the specified character is a valid NCName character as defined by production [5] in Namespaces in XML 1.1 recommendation.
static boolean isXML11NCNameStart(int c)
Returns true if the specified character is a valid NCName start character as defined by production [4] in Namespaces in XML 1.1 recommendation.
static boolean isXML11Name(int c)
Returns true if the specified character is a valid name character as defined by production [4a] in the XML 1.1 specification.
static boolean isXML11NameHighSurrogate(int c)
Returns whether the given character is a valid high surrogate for a name character.
static boolean isXML11NameStart(int c)
Returns true if the specified character is a valid name start character as defined by production [4] in the XML 1.1 specification.
static boolean isXML11Space(int c)
Returns true if the specified character is a space character as amdended in the XML 1.1 specification.
static boolean isXML11Valid(int c)
Returns true if the specified character is valid.
static boolean isXML11ValidLiteral(int c)
Returns true if the specified character is valid and permitted outside of a character reference.
static boolean isXML11ValidNCName(String ncName)
Check to see if a string is a valid NCName according to [4] from the XML Namespaces 1.1 Recommendation
static boolean isXML11ValidName(String name)
Check to see if a string is a valid Name according to [5] in the XML 1.1 Recommendation
static boolean isXML11ValidNmtoken(String nmtoken)
Check to see if a string is a valid Nmtoken according to [7] in the XML 1.1 Recommendation
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int MASK_XML11_CONTENT

XML 1.1 content for external entities (valid - "special" chars - control chars)

Constant Value: 32 (0x00000020)

public static final int MASK_XML11_CONTENT_INTERNAL

XML 1.1 content for internal entities (valid - "special" chars)

Constant Value: 48 (0x00000030)

public static final int MASK_XML11_CONTROL

XML 1.1 control character mask

Constant Value: 16 (0x00000010)

public static final int MASK_XML11_NAME

XML 1.1 Name character mask.

Constant Value: 8 (0x00000008)

public static final int MASK_XML11_NAME_START

XML 1.1 Name start character mask.

Constant Value: 4 (0x00000004)

public static final int MASK_XML11_NCNAME

XML namespaces 1.1 NCName

Constant Value: 128 (0x00000080)

public static final int MASK_XML11_NCNAME_START

XML namespaces 1.1 NCNameStart

Constant Value: 64 (0x00000040)

public static final int MASK_XML11_SPACE

XML 1.1 Space character mask.

Constant Value: 2 (0x00000002)

public static final int MASK_XML11_VALID

XML 1.1 Valid character mask.

Constant Value: 1 (0x00000001)

Public Constructors

public XML11Char ()

Public Methods

public static boolean isXML11Content (int c)

Returns true if the specified character can be considered content in an external parsed entity.

Parameters
c The character to check.

public static boolean isXML11InternalEntityContent (int c)

Returns true if the specified character can be considered content in an internal parsed entity.

Parameters
c The character to check.

public static boolean isXML11Invalid (int c)

Returns true if the specified character is invalid.

Parameters
c The character to check.

public static boolean isXML11NCName (int c)

Returns true if the specified character is a valid NCName character as defined by production [5] in Namespaces in XML 1.1 recommendation.

Parameters
c The character to check.

public static boolean isXML11NCNameStart (int c)

Returns true if the specified character is a valid NCName start character as defined by production [4] in Namespaces in XML 1.1 recommendation.

Parameters
c The character to check.

public static boolean isXML11Name (int c)

Returns true if the specified character is a valid name character as defined by production [4a] in the XML 1.1 specification.

Parameters
c The character to check.

public static boolean isXML11NameHighSurrogate (int c)

Returns whether the given character is a valid high surrogate for a name character. This includes all high surrogates for characters [0x10000-0xEFFFF]. In other words everything excluding planes 15 and 16.

Parameters
c The character to check.

public static boolean isXML11NameStart (int c)

Returns true if the specified character is a valid name start character as defined by production [4] in the XML 1.1 specification.

Parameters
c The character to check.

public static boolean isXML11Space (int c)

Returns true if the specified character is a space character as amdended in the XML 1.1 specification.

Parameters
c The character to check.

public static boolean isXML11Valid (int c)

Returns true if the specified character is valid. This method also checks the surrogate character range from 0x10000 to 0x10FFFF.

If the program chooses to apply the mask directly to the XML11CHARS array, then they are responsible for checking the surrogate character range.

Parameters
c The character to check.

public static boolean isXML11ValidLiteral (int c)

Returns true if the specified character is valid and permitted outside of a character reference. That is, this method will return false for the same set as isXML11Valid, except it also reports false for "control characters".

Parameters
c The character to check.

public static boolean isXML11ValidNCName (String ncName)

Check to see if a string is a valid NCName according to [4] from the XML Namespaces 1.1 Recommendation

Parameters
ncName string to check
Returns
  • true if name is a valid NCName

public static boolean isXML11ValidName (String name)

Check to see if a string is a valid Name according to [5] in the XML 1.1 Recommendation

Parameters
name string to check
Returns
  • true if name is a valid Name

public static boolean isXML11ValidNmtoken (String nmtoken)

Check to see if a string is a valid Nmtoken according to [7] in the XML 1.1 Recommendation

Parameters
nmtoken string to check
Returns
  • true if nmtoken is a valid Nmtoken