|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.impl.XMLScanner
public abstract class XMLScanner
This class is responsible for holding scanning methods common to scanning the XML document structure and content as well as the DTD structure and content. Both XMLDocumentScanner and XMLDTDScanner inherit from this base class.
This component requires the following features and properties from the component manager that uses it:
Constructor Summary | |
---|---|
XMLScanner()
|
Method Summary | |
---|---|
void |
endEntity(java.lang.String name,
Augmentations augs)
This method notifies the end of an entity. |
boolean |
getFeature(java.lang.String featureId)
|
void |
reset(XMLComponentManager componentManager)
Resets the component. |
java.lang.String |
scanPseudoAttribute(boolean scanningTextDecl,
XMLString value)
Scans a pseudo attribute. |
void |
setFeature(java.lang.String featureId,
boolean value)
Sets the state of a feature. |
void |
setProperty(java.lang.String propertyId,
java.lang.Object value)
Sets the value of a property during parsing. |
void |
startEntity(java.lang.String name,
XMLResourceIdentifier identifier,
java.lang.String encoding,
Augmentations augs)
This method notifies of the start of an entity. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.xerces.xni.parser.XMLComponent |
---|
getFeatureDefault, getPropertyDefault, getRecognizedFeatures, getRecognizedProperties |
Constructor Detail |
---|
public XMLScanner()
Method Detail |
---|
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(java.lang.String propertyId, java.lang.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(java.lang.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(java.lang.String featureId) throws XMLConfigurationException
XMLConfigurationException
public java.lang.String scanPseudoAttribute(boolean scanningTextDecl, XMLString value) throws java.io.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.
java.io.IOException
XNIException
public void startEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.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 augmentations
XNIException
- Thrown by handler to signal an error.public void endEntity(java.lang.String name, Augmentations augs) throws XNIException
name
- The name of the entity.augs
- Additional information that may include infoset augmentations
XNIException
- Thrown by handler to signal an error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |