APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.util

public Class XML11Char

extends Object
Class Inheritance
Imports
java.util.Arrays
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.

Authors
Glenn Marcy, IBM, Andy Clark, IBM, Arnaud Le Hors, IBM, Neil Graham, IBM, Michael Glavassevich, IBM

Field Summary

Modifier and TypeField and Description
public static final int
MASK_XML11_CONTENT

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

public static final int
MASK_XML11_CONTENT_INTERNAL

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

public static final int
MASK_XML11_CONTROL

XML 1.1 control character mask

public static final int
MASK_XML11_NAME

XML 1.1 Name character mask.

public static final int
MASK_XML11_NAME_START

XML 1.1 Name start character mask.

public static final int
MASK_XML11_NCNAME

XML namespaces 1.1 NCName

public static final int
MASK_XML11_NCNAME_START

XML namespaces 1.1 NCNameStart

public static final int
MASK_XML11_SPACE

XML 1.1 Space character mask.

public static final int
MASK_XML11_VALID

XML 1.1 Valid character mask.

private static final byte[]
XML11CHARS

Character flags for XML 1.1.

Constructor Summary

AccessConstructor and Description
public
XML11Char()

Method Summary

Modifier and TypeMethod and Description
public static boolean
isXML11Content(int
The character to check.
c)

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

public static boolean
isXML11InternalEntityContent(int
The character to check.
c)

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

public static boolean
isXML11Invalid(int
The character to check.
c)

Returns true if the specified character is invalid.

public static boolean
isXML11Name(int
The character to check.
c)

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

public static boolean
isXML11NameHighSurrogate(int
The character to check.
c)

Returns whether the given character is a valid high surrogate for a name character.

public static boolean
isXML11NameStart(int
The character to check.
c)

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

public static boolean
isXML11NCName(int
The character to check.
c)

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

public static boolean
isXML11NCNameStart(int
The character to check.
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.

public static boolean
isXML11Space(int
The character to check.
c)

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

public static boolean
isXML11Valid(int
The character to check.
c)

Returns true if the specified character is valid.

public static boolean
isXML11ValidLiteral(int
The character to check.
c)

Returns true if the specified character is valid and permitted outside of a character reference.

public static boolean

Returns:

true if name is a valid Name
isXML11ValidName(String
string to check
name)

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

public static boolean

Returns:

true if name is a valid NCName
isXML11ValidNCName(String
string to check
ncName)

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

public static boolean

Returns:

true if nmtoken is a valid Nmtoken
isXML11ValidNmtoken(String
string to check
nmtoken)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

MASK_XML11_CONTENTback to summary
public static final int MASK_XML11_CONTENT

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

MASK_XML11_CONTENT_INTERNALback to summary
public static final int MASK_XML11_CONTENT_INTERNAL

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

MASK_XML11_CONTROLback to summary
public static final int MASK_XML11_CONTROL

XML 1.1 control character mask

MASK_XML11_NAMEback to summary
public static final int MASK_XML11_NAME

XML 1.1 Name character mask.

MASK_XML11_NAME_STARTback to summary
public static final int MASK_XML11_NAME_START

XML 1.1 Name start character mask.

MASK_XML11_NCNAMEback to summary
public static final int MASK_XML11_NCNAME

XML namespaces 1.1 NCName

MASK_XML11_NCNAME_STARTback to summary
public static final int MASK_XML11_NCNAME_START

XML namespaces 1.1 NCNameStart

MASK_XML11_SPACEback to summary
public static final int MASK_XML11_SPACE

XML 1.1 Space character mask.

MASK_XML11_VALIDback to summary
public static final int MASK_XML11_VALID

XML 1.1 Valid character mask.

XML11CHARSback to summary
private static final byte[] XML11CHARS

Character flags for XML 1.1.

Constructor Detail

XML11Charback to summary
public XML11Char()

Method Detail

isXML11Contentback to summary
public static boolean isXML11Content(int c)

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

Parameters
c:int

The character to check.

isXML11InternalEntityContentback to summary
public static boolean isXML11InternalEntityContent(int c)

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

Parameters
c:int

The character to check.

isXML11Invalidback to summary
public static boolean isXML11Invalid(int c)

Returns true if the specified character is invalid.

Parameters
c:int

The character to check.

isXML11Nameback to summary
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:int

The character to check.

isXML11NameHighSurrogateback to summary
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:int

The character to check.

isXML11NameStartback to summary
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:int

The character to check.

isXML11NCNameback to summary
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:int

The character to check.

isXML11NCNameStartback to summary
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:int

The character to check.

isXML11Spaceback to summary
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:int

The character to check.

isXML11Validback to summary
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:int

The character to check.

isXML11ValidLiteralback to summary
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:int

The character to check.

isXML11ValidNameback to summary
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

string to check

Returns:boolean

true if name is a valid Name

isXML11ValidNCNameback to summary
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

string to check

Returns:boolean

true if name is a valid NCName

isXML11ValidNmtokenback to summary
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

string to check

Returns:boolean

true if nmtoken is a valid Nmtoken