public abstract class XMLScanner extends Object implements XMLComponent
This component requires the following features and properties from the component manager that uses it:
Modifier and Type | Field and Description |
---|---|
protected static boolean |
DEBUG_ATTR_NORMALIZATION
Debug attribute normalization.
|
protected static String |
ENTITY_MANAGER
Property identifier: entity manager.
|
protected static String |
ERROR_REPORTER
Property identifier: error reporter.
|
protected static String |
fAmpSymbol
Symbol: "amp".
|
protected static String |
fAposSymbol
Symbol: "apos".
|
protected String |
fCharRefLiteral
Literal value of the last character refence scanned.
|
protected static String |
fEncodingSymbol
Symbol: "encoding".
|
protected int |
fEntityDepth
Entity depth.
|
protected XMLEntityManager |
fEntityManager
Entity manager.
|
protected XMLEntityScanner |
fEntityScanner
Entity scanner.
|
protected XMLErrorReporter |
fErrorReporter
Error reporter.
|
protected static String |
fGtSymbol
Symbol: "gt".
|
protected static String |
fLtSymbol
Symbol: "lt".
|
protected boolean |
fNamespaces
Namespaces.
|
protected boolean |
fNotifyCharRefs
Character references notification.
|
protected boolean |
fParserSettings
Internal parser-settings feature
|
protected static String |
fQuotSymbol
Symbol: "quot".
|
protected boolean |
fReportEntity
Report entity boundary.
|
protected XMLResourceIdentifierImpl |
fResourceIdentifier |
protected boolean |
fScanningAttribute
Scanning attribute.
|
protected static String |
fStandaloneSymbol
Symbol: "standalone".
|
protected SymbolTable |
fSymbolTable
Symbol table.
|
protected boolean |
fValidation
Validation.
|
protected static String |
fVersionSymbol
Symbol: "version".
|
protected static String |
NAMESPACES
Feature identifier: namespaces.
|
protected static String |
NOTIFY_CHAR_REFS
Feature identifier: notify character references.
|
protected static String |
PARSER_SETTINGS |
protected static String |
SYMBOL_TABLE
Property identifier: symbol table.
|
protected static String |
VALIDATION
Feature identifier: validation.
|
Constructor and Description |
---|
XMLScanner() |
Modifier and Type | Method and Description |
---|---|
void |
endEntity(String name,
Augmentations augs)
This method notifies the end of an entity.
|
boolean |
getFeature(String featureId) |
protected String |
getVersionNotSupportedKey() |
protected boolean |
isInvalid(int value) |
protected boolean |
isInvalidLiteral(int value) |
protected int |
isUnchangedByNormalization(XMLString value)
Checks whether this string would be unchanged by normalization.
|
protected boolean |
isValidNameChar(int value) |
protected boolean |
isValidNameStartChar(int value) |
protected boolean |
isValidNameStartHighSurrogate(int value) |
protected boolean |
isValidNCName(int value) |
protected void |
normalizeWhitespace(XMLString value)
Normalize whitespace in an XMLString converting all whitespace
characters to space characters.
|
protected void |
normalizeWhitespace(XMLString value,
int fromIndex)
Normalize whitespace in an XMLString converting all whitespace
characters to space characters.
|
protected void |
reportFatalError(String msgId,
Object[] args)
Convenience function used in all XML scanners.
|
protected void |
reset() |
void |
reset(XMLComponentManager componentManager)
Resets the component.
|
protected boolean |
scanAttributeValue(XMLString value,
XMLString nonNormalizedValue,
String atName,
boolean checkEntities,
String eleName)
Scans an attribute value and normalizes whitespace converting all
whitespace characters to space characters.
|
protected int |
scanCharReferenceValue(XMLStringBuffer buf,
XMLStringBuffer buf2)
Scans a character reference and append the corresponding chars to the
specified buffer.
|
protected void |
scanComment(XMLStringBuffer text)
Scans a comment.
|
protected void |
scanExternalID(String[] identifiers,
boolean optionalSystemId)
Scans External ID and return the public and system IDs.
|
protected void |
scanPI()
Scans a processing instruction.
|
protected void |
scanPIData(String target,
XMLString data)
Scans a processing data.
|
String |
scanPseudoAttribute(boolean scanningTextDecl,
XMLString value)
Scans a pseudo attribute.
|
protected boolean |
scanPubidLiteral(XMLString literal)
Scans public ID literal.
|
protected boolean |
scanSurrogates(XMLStringBuffer buf)
Scans surrogates and append them to the specified buffer.
|
protected void |
scanXMLDeclOrTextDecl(boolean scanningTextDecl,
String[] pseudoAttributeValues)
Scans an XML or text declaration.
|
void |
setFeature(String featureId,
boolean value)
Sets the state of a feature.
|
void |
setProperty(String propertyId,
Object value)
Sets the value of a property during parsing.
|
void |
startEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
Augmentations augs)
This method notifies of the start of an entity.
|
protected boolean |
versionSupported(String version) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getFeatureDefault, getPropertyDefault, getRecognizedFeatures, getRecognizedProperties
protected static final String VALIDATION
protected static final String NAMESPACES
protected static final String NOTIFY_CHAR_REFS
protected static final String PARSER_SETTINGS
protected static final String SYMBOL_TABLE
protected static final String ERROR_REPORTER
protected static final String ENTITY_MANAGER
protected static final boolean DEBUG_ATTR_NORMALIZATION
protected boolean fValidation
protected boolean fNamespaces
protected boolean fNotifyCharRefs
protected boolean fParserSettings
protected SymbolTable fSymbolTable
protected XMLErrorReporter fErrorReporter
protected XMLEntityManager fEntityManager
protected XMLEntityScanner fEntityScanner
protected int fEntityDepth
protected String fCharRefLiteral
protected boolean fScanningAttribute
protected boolean fReportEntity
protected static final String fVersionSymbol
protected static final String fEncodingSymbol
protected static final String fStandaloneSymbol
protected static final String fAmpSymbol
protected static final String fLtSymbol
protected static final String fGtSymbol
protected static final String fQuotSymbol
protected static final String fAposSymbol
protected final XMLResourceIdentifierImpl fResourceIdentifier
public void reset(XMLComponentManager componentManager) throws XMLConfigurationException
XMLComponent
reset
in interface XMLComponent
componentManager
- The component manager.SAXException
- Throws exception if required features and
properties cannot be found.XMLConfigurationException
public void setProperty(String propertyId, Object value) throws XMLConfigurationException
setProperty
in interface XMLComponent
propertyId
- value
- XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public void setFeature(String featureId, boolean value) throws XMLConfigurationException
XMLComponent
Note: Components should silently ignore features that do not affect the operation of the component.
setFeature
in interface XMLComponent
featureId
- The feature identifier.value
- The state of the feature.XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public boolean getFeature(String featureId) throws XMLConfigurationException
XMLConfigurationException
protected void reset()
protected void scanXMLDeclOrTextDecl(boolean scanningTextDecl, String[] pseudoAttributeValues) throws IOException, XNIException
[23] XMLDecl ::= '' [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'" ) [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')* [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no') '"')) [77] TextDecl ::= ''
scanningTextDecl
- True if a text declaration is to
be scanned instead of an XML
declaration.pseudoAttributeValues
- An array of size 3 to return the version,
encoding and standalone pseudo attribute values
(in that order).
Note: This method uses fString, anything in it
at the time of calling is lost.IOException
XNIException
public String scanPseudoAttribute(boolean scanningTextDecl, XMLString value) throws IOException, XNIException
scanningTextDecl
- True if scanning this pseudo-attribute for a
TextDecl; false if scanning XMLDecl. This
flag is needed to report the correct type of
error.value
- The string to fill in with the attribute
value.IOException
XNIException
protected void scanPI() throws IOException, XNIException
[16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))Note: This method uses fString, anything in it at the time of calling is lost.
IOException
XNIException
protected void scanPIData(String target, XMLString data) throws IOException, XNIException
target
- The PI targetdata
- The string to fill in with the dataIOException
XNIException
protected void scanComment(XMLStringBuffer text) throws IOException, XNIException
[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
Note: Called after scanning past '<!--' Note: This method uses fString, anything in it at the time of calling is lost.
text
- The buffer to fill in with the text.IOException
XNIException
protected boolean scanAttributeValue(XMLString value, XMLString nonNormalizedValue, String atName, boolean checkEntities, String eleName) throws IOException, XNIException
value
- The XMLString to fill in with the value.nonNormalizedValue
- The XMLString to fill in with the
non-normalized value.atName
- The name of the attribute being parsed (for error msgs).checkEntities
- true if undeclared entities should be reported as VC violation,
false if undeclared entities should be reported as WFC violation.eleName
- The name of element to which this attribute belongs.IOException
XNIException
protected void scanExternalID(String[] identifiers, boolean optionalSystemId) throws IOException, XNIException
identifiers
- An array of size 2 to return the system id,
and public id (in that order).optionalSystemId
- Specifies whether the system id is optional.
Note: This method uses fString and fStringBuffer,
anything in them at the time of calling is lost.IOException
XNIException
protected boolean scanPubidLiteral(XMLString literal) throws IOException, XNIException
literal
- The string to fill in with the public ID literal.IOException
XNIException
protected void normalizeWhitespace(XMLString value)
protected void normalizeWhitespace(XMLString value, int fromIndex)
protected int isUnchangedByNormalization(XMLString value)
public void startEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException
name
- The name of the entity.identifier
- The resource identifier.encoding
- The auto-detected IANA encoding name of the entity
stream. This value will be null in those situations
where the entity encoding is not auto-detected (e.g.
internal entities or a document entity that is
parsed from a java.io.Reader).augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.public void endEntity(String name, Augmentations augs) throws XNIException
name
- The name of the entity.augs
- Additional information that may include infoset augmentationsXNIException
- Thrown by handler to signal an error.protected int scanCharReferenceValue(XMLStringBuffer buf, XMLStringBuffer buf2) throws IOException, XNIException
[66] CharRef ::= '' [0-9]+ ';' | '' [0-9a-fA-F]+ ';'Note: This method uses fStringBuffer, anything in it at the time of calling is lost.
buf
- the character buffer to append chars tobuf2
- the character buffer to append non-normalized chars toIOException
XNIException
protected boolean isInvalid(int value)
protected boolean isInvalidLiteral(int value)
protected boolean isValidNameChar(int value)
protected boolean isValidNameStartChar(int value)
protected boolean isValidNCName(int value)
protected boolean isValidNameStartHighSurrogate(int value)
protected boolean versionSupported(String version)
protected String getVersionNotSupportedKey()
protected boolean scanSurrogates(XMLStringBuffer buf) throws IOException, XNIException
Note: This assumes the current char has already been identified as a high surrogate.
buf
- The StringBuffer to append the read surrogates to.IOException
XNIException
protected void reportFatalError(String msgId, Object[] args) throws XNIException
XNIException
Copyright © 2018 JBoss by Red Hat. All rights reserved.