XMLEntityManager (openjdk7-jaxp-external 7.60.33 API)

java.lang.Object
- jdk7u.jaxp.org.apache.xerces.external.impl.XMLEntityManager

All Implemented Interfaces:

XMLComponent, XMLEntityResolver
```
public class XMLEntityManager
extends Object
implements XMLComponent, XMLEntityResolver
```
Will keep track of current entity. The entity manager handles the registration of general and parameter entities; resolves entities; and starts entities. The entity manager is a central component in a standard parser configuration and this class works directly with the entity scanner to manage the underlying xni.
This component requires the following features and properties from the component manager that uses it:
- http://xml.org/sax/features/validation
- http://xml.org/sax/features/external-general-entities
- http://xml.org/sax/features/external-parameter-entities
- http://apache.org/xml/features/allow-java-encodings
- http://apache.org/xml/properties/external/symbol-table
- http://apache.org/xml/properties/external/error-reporter
- http://apache.org/xml/properties/external/entity-resolver
Version:

$Id: XMLEntityManager.java,v 1.17 2010-11-01 04:39:41 joehw Exp $

Author:

Andy Clark, IBM, Arnaud Le Hors, IBM, K.Venugopal SUN Microsystems, Neeraj Bajaj SUN Microsystems, Sunitha Reddy SUN Microsystems

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class XMLEntityManager.RewindableInputStream
This class wraps the byte inputstreams we're presented with.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`XMLEntityManager.RewindableInputStream` This class wraps the byte inputstreams we're presented with.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ALLOW_JAVA_ENCODINGS` Feature identifier: allow Java encodings.
`protected static String`	`BUFFER_SIZE` property identifier: buffer size.
`static int`	`DEFAULT_BUFFER_SIZE` Default buffer size (2048).
`static int`	`DEFAULT_INTERNAL_BUFFER_SIZE` Default internal entity buffer size (1024).
`static int`	`DEFAULT_XMLDECL_BUFFER_SIZE` Default buffer size before we've finished with the XMLDecl:
`protected Object[]`	`defaultEncoding`
`protected static String`	`ENTITY_RESOLVER` Property identifier: entity resolver.
`protected int`	`entityExpansionIndex`
`protected static String`	`ERROR_REPORTER` Property identifier: error reporter.
`protected static String`	`EXTERNAL_GENERAL_ENTITIES` Feature identifier: external general entities.
`protected static String`	`EXTERNAL_PARAMETER_ENTITIES` Feature identifier: external parameter entities.
`protected String`	`fAccessExternalDTD` used to restrict external access
`protected boolean`	`fAllowJavaEncodings` Allow Java encoding names.
`protected int`	`fBufferSize` Buffer size.
`protected Entity.ScannedEntity`	`fCurrentEntity` Current entity.
`protected Hashtable`	`fEntities` Entities.
`protected int`	`fEntityExpansionCount` count of entities expanded:
`protected XMLEntityHandler`	`fEntityHandler` Entity handler.
`protected XMLEntityResolver`	`fEntityResolver` Entity resolver.
`protected XMLEntityScanner`	`fEntityScanner` Current entity scanner
`protected Stack`	`fEntityStack` Entity stack.
`protected XMLEntityStorage`	`fEntityStorage`
`protected XMLErrorReporter`	`fErrorReporter` Error reporter.
`protected boolean`	`fExternalGeneralEntities` External general entities.
`protected boolean`	`fExternalParameterEntities` External parameter entities.
`protected boolean`	`fInExternalSubset`
`protected XMLLimitAnalyzer`	`fLimitAnalyzer`
`protected boolean`	`fLoadExternalDTD` Load external DTD.
`protected PropertyManager`	`fPropertyManager` Property Manager.
`protected XMLSecurityManager`	`fSecurityManager` Security Manager
`protected boolean`	`fStandalone` True if the document entity is standalone.
`protected StaxEntityResolverWrapper`	`fStaxEntityResolver` Stax Entity Resolver.
`protected boolean`	`fStrictURI` standard uri conformant (strict uri).
`protected SymbolTable`	`fSymbolTable` Symbol table.
`protected boolean`	`fValidation` Validation.
`protected ValidationManager`	`fValidationManager` Validation manager.
`protected boolean`	`fWarnDuplicateEntityDef` warn on duplicate Entity declaration.
`protected XMLEntityScanner`	`fXML10EntityScanner` XML 1.0 entity scanner.
`protected XMLEntityScanner`	`fXML11EntityScanner` XML 1.1 entity scanner.
`protected static String`	`LOAD_EXTERNAL_DTD` Feature identifier: load external DTD.
`protected static String`	`PARSER_SETTINGS`
`protected static String`	`SECURITY_MANAGER` property identifier: security manager.
`protected static String`	`STANDARD_URI_CONFORMANT` Feature identifier: standard uri conformant
`protected static String`	`STAX_ENTITY_RESOLVER`
`protected static String`	`SYMBOL_TABLE` Property identifier: symbol table.
`protected static String`	`VALIDATION` Feature identifier: validation.
`protected static String`	`VALIDATION_MANAGER`
`protected static String`	`WARN_ON_DUPLICATE_ENTITYDEF` Feature identifier: warn on duplicate EntityDef

Constructor Summary

Constructors
Constructor and Description
`XMLEntityManager()` If this constructor is used to create the object, reset() should be invoked on this object
`XMLEntityManager(PropertyManager propertyManager)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`absolutizeAgainstUserDir(URI uri)` Absolutizes a URI using the current value of the "user.dir" property as the base URI.
`void`	`addExternalEntity(String name, String publicId, String literalSystemId, String baseSystemId)` Adds an external entity declaration.
`void`	`addInternalEntity(String name, String text)` Adds an internal entity declaration.
`void`	`addUnparsedEntity(String name, String publicId, String systemId, String baseSystemId, String notation)` Adds an unparsed entity declaration.
`void`	`closeReaders()` Close all opened InputStreams and Readers opened by this parser.
`protected Reader`	`createReader(InputStream inputStream, String encoding, Boolean isBigEndian)` Creates a reader capable of reading the given input stream in the specified encoding.
`void`	`endEntity()`
`void`	`endExternalSubset()`
`static String`	`expandSystemId(String systemId)` Expands a system id and returns the system id as a URI, if it can be expanded.
`static String`	`expandSystemId(String systemId, String baseSystemId)` Expands a system id and returns the system id as a URI, if it can be expanded.
`static String`	`expandSystemId(String systemId, String baseSystemId, boolean strict)` Expands a system id and returns the system id as a URI, if it can be expanded.
`protected static String`	`fixURI(String str)` Fixes a platform dependent filename to standard URI form.
`int`	`getColumnNumber()` Return the column number where the current document event ends.
`Entity.ScannedEntity`	`getCurrentEntity()` Return the current entity being scanned.
`XMLResourceIdentifier`	`getCurrentResourceIdentifier()`
`protected Object[]`	`getEncodingName(byte[] b4, int count)` Returns the IANA encoding name that is auto-detected from the bytes specified, with the endian-ness of that encoding where appropriate.
`XMLEntityScanner`	`getEntityScanner()` return the entity responsible for reading the entity
`XMLEntityStorage`	`getEntityStore()` get the entity storage object from entity manager
`String`	`getExpandedSystemId()` Return the expanded system identifier for the current document event.
`Boolean`	`getFeatureDefault(String featureId)` Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
`int`	`getLineNumber()` Return the line number where the current document event ends.
`String`	`getLiteralSystemId()` Return the literal system identifier for the current document event.
`Object`	`getPropertyDefault(String propertyId)` Returns the default state for a property, or null if this component does not want to report a default value for this property.
`String`	`getPublicId()` Return the public identifier for the current document event.
`String[]`	`getRecognizedFeatures()` Returns a list of feature identifiers that are recognized by this component.
`String[]`	`getRecognizedProperties()` Returns a list of property identifiers that are recognized by this component.
`Entity.ScannedEntity`	`getTopLevelEntity()` Return the top level entity handled by this manager, or null if no entity was added.
`boolean`	`isDeclaredEntity(String entityName)`
`boolean`	`isEntityDeclInExternalSubset(String entityName)` Checks whether the declaration of an entity given by name is // in the external subset.
`boolean`	`isExternalEntity(String entityName)` Checks whether an entity given by name is external.
`boolean`	`isStandalone()` Returns true if the document entity is standalone.
`boolean`	`isUnparsedEntity(String entityName)`
`void`	`reset()`
`void`	`reset(PropertyManager propertyManager)`
`void`	`reset(XMLComponentManager componentManager)` Resets the component.
`XMLInputSource`	`resolveEntity(XMLResourceIdentifier resourceIdentifier)` Resolves the specified public and system identifiers.
`StaxXMLInputSource`	`resolveEntityAsPerStax(XMLResourceIdentifier resourceIdentifier)`
`void`	`setEntityHandler(XMLEntityHandler entityHandler)` Sets the entity handler.
`void`	`setFeature(String featureId, boolean state)` Sets the state of a feature.
`static void`	`setInstanceFollowRedirects(HttpURLConnection urlCon, boolean followRedirects)` Attempt to set whether redirects will be followed for an `HttpURLConnection`.
`void`	`setLimitAnalyzer(XMLLimitAnalyzer fLimitAnalyzer)`
`void`	`setProperty(String propertyId, Object value)` Sets the value of a property.
`void`	`setScannerVersion(short version)`
`void`	`setStandalone(boolean standalone)` Sets whether the document entity is standalone.
`String`	`setupCurrentEntity(String name, XMLInputSource xmlInputSource, boolean literal, boolean isExternal)` This method uses the passed-in XMLInputSource to make fCurrentEntity usable for reading.
`void`	`startDocumentEntity(XMLInputSource xmlInputSource)` Starts the document entity.
`void`	`startDTDEntity(XMLInputSource xmlInputSource)` Starts the DTD entity.
`void`	`startEntity(String entityName, boolean literal)` Starts a named entity.
`void`	`startEntity(String name, XMLInputSource xmlInputSource, boolean literal, boolean isExternal)` Starts an entity.
`void`	`startExternalSubset()`
`void`	`test()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    Default buffer size (2048).
    
    See Also:
    Constant Field Values
  - DEFAULT_XMLDECL_BUFFER_SIZE
```
public static final int DEFAULT_XMLDECL_BUFFER_SIZE
```
    Default buffer size before we've finished with the XMLDecl:
    
    See Also:
    Constant Field Values
  - DEFAULT_INTERNAL_BUFFER_SIZE
```
public static final int DEFAULT_INTERNAL_BUFFER_SIZE
```
    Default internal entity buffer size (1024).
    
    See Also:
    Constant Field Values
  - VALIDATION
```
protected static final String VALIDATION
```
    Feature identifier: validation.
    
    See Also:
    Constant Field Values
  - fStrictURI
```
protected boolean fStrictURI
```
    standard uri conformant (strict uri). http://apache.org/xml/features/standard-uri-conformant
  - EXTERNAL_GENERAL_ENTITIES
```
protected static final String EXTERNAL_GENERAL_ENTITIES
```
    Feature identifier: external general entities.
    
    See Also:
    Constant Field Values
  - EXTERNAL_PARAMETER_ENTITIES
```
protected static final String EXTERNAL_PARAMETER_ENTITIES
```
    Feature identifier: external parameter entities.
    
    See Also:
    Constant Field Values
  - ALLOW_JAVA_ENCODINGS
```
protected static final String ALLOW_JAVA_ENCODINGS
```
    Feature identifier: allow Java encodings.
    
    See Also:
    Constant Field Values
  - WARN_ON_DUPLICATE_ENTITYDEF
```
protected static final String WARN_ON_DUPLICATE_ENTITYDEF
```
    Feature identifier: warn on duplicate EntityDef
    
    See Also:
    Constant Field Values
  - LOAD_EXTERNAL_DTD
```
protected static final String LOAD_EXTERNAL_DTD
```
    Feature identifier: load external DTD.
    
    See Also:
    Constant Field Values
  - SYMBOL_TABLE
```
protected static final String SYMBOL_TABLE
```
    Property identifier: symbol table.
    
    See Also:
    Constant Field Values
  - ERROR_REPORTER
```
protected static final String ERROR_REPORTER
```
    Property identifier: error reporter.
    
    See Also:
    Constant Field Values
  - STANDARD_URI_CONFORMANT
```
protected static final String STANDARD_URI_CONFORMANT
```
    Feature identifier: standard uri conformant
    
    See Also:
    Constant Field Values
  - ENTITY_RESOLVER
```
protected static final String ENTITY_RESOLVER
```
    Property identifier: entity resolver.
    
    See Also:
    Constant Field Values
  - STAX_ENTITY_RESOLVER
```
protected static final String STAX_ENTITY_RESOLVER
```
    See Also:
    Constant Field Values
  - VALIDATION_MANAGER
```
protected static final String VALIDATION_MANAGER
```
    See Also:
    Constant Field Values
  - BUFFER_SIZE
```
protected static final String BUFFER_SIZE
```
    property identifier: buffer size.
    
    See Also:
    Constant Field Values
  - SECURITY_MANAGER
```
protected static final String SECURITY_MANAGER
```
    property identifier: security manager.
    
    See Also:
    Constant Field Values
  - PARSER_SETTINGS
```
protected static final String PARSER_SETTINGS
```
    See Also:
    Constant Field Values
  - fWarnDuplicateEntityDef
```
protected boolean fWarnDuplicateEntityDef
```
    warn on duplicate Entity declaration. http://apache.org/xml/features/warn-on-duplicate-entitydef
  - fValidation
```
protected boolean fValidation
```
    Validation. This feature identifier is: http://xml.org/sax/features/validation
  - fExternalGeneralEntities
```
protected boolean fExternalGeneralEntities
```
    External general entities. This feature identifier is: http://xml.org/sax/features/external-general-entities
  - fExternalParameterEntities
```
protected boolean fExternalParameterEntities
```
    External parameter entities. This feature identifier is: http://xml.org/sax/features/external-parameter-entities
  - fAllowJavaEncodings
```
protected boolean fAllowJavaEncodings
```
    Allow Java encoding names. This feature identifier is: http://apache.org/xml/features/allow-java-encodings
  - fLoadExternalDTD
```
protected boolean fLoadExternalDTD
```
    Load external DTD.
  - fSymbolTable
```
protected SymbolTable fSymbolTable
```
    Symbol table. This property identifier is: http://apache.org/xml/properties/external/symbol-table
  - fErrorReporter
```
protected XMLErrorReporter fErrorReporter
```
    Error reporter. This property identifier is: http://apache.org/xml/properties/external/error-reporter
  - fEntityResolver
```
protected XMLEntityResolver fEntityResolver
```
    Entity resolver. This property identifier is: http://apache.org/xml/properties/external/entity-resolver
  - fStaxEntityResolver
```
protected StaxEntityResolverWrapper fStaxEntityResolver
```
    Stax Entity Resolver. This property identifier is XMLInputFactory.ENTITY_RESOLVER
  - fPropertyManager
```
protected PropertyManager fPropertyManager
```
    Property Manager. This is used from Stax
  - fAccessExternalDTD
```
protected String fAccessExternalDTD
```
    used to restrict external access
  - fValidationManager
```
protected ValidationManager fValidationManager
```
    Validation manager. This property identifier is: http://apache.org/xml/properties/external/validation-manager
  - fBufferSize
```
protected int fBufferSize
```
    Buffer size. We get this value from a property. The default size is used if the input buffer size property is not specified. REVISIT: do we need a property for internal entity buffer size?
  - fSecurityManager
```
protected XMLSecurityManager fSecurityManager
```
    Security Manager
  - fLimitAnalyzer
```
protected XMLLimitAnalyzer fLimitAnalyzer
```
  - entityExpansionIndex
```
protected int entityExpansionIndex
```
  - fStandalone
```
protected boolean fStandalone
```
    True if the document entity is standalone. This should really only be set by the document source (e.g. XMLDocumentScanner).
  - fInExternalSubset
```
protected boolean fInExternalSubset
```
  - fEntityHandler
```
protected XMLEntityHandler fEntityHandler
```
    Entity handler.
  - fEntityScanner
```
protected XMLEntityScanner fEntityScanner
```
    Current entity scanner
  - fXML10EntityScanner
```
protected XMLEntityScanner fXML10EntityScanner
```
    XML 1.0 entity scanner.
  - fXML11EntityScanner
```
protected XMLEntityScanner fXML11EntityScanner
```
    XML 1.1 entity scanner.
  - fEntityExpansionCount
```
protected int fEntityExpansionCount
```
    count of entities expanded:
  - fEntities
```
protected Hashtable fEntities
```
    Entities.
  - fEntityStack
```
protected Stack fEntityStack
```
    Entity stack.
  - fCurrentEntity
```
protected Entity.ScannedEntity fCurrentEntity
```
    Current entity.
  - fEntityStorage
```
protected XMLEntityStorage fEntityStorage
```
  - defaultEncoding
```
protected final Object[] defaultEncoding
```
- Constructor Detail
  - XMLEntityManager
```
public XMLEntityManager()
```
    If this constructor is used to create the object, reset() should be invoked on this object
  - XMLEntityManager
```
public XMLEntityManager(PropertyManager propertyManager)
```
    Default constructor.
- Method Detail
  - addInternalEntity
```
public void addInternalEntity(String name,
                     String text)
```
    Adds an internal entity declaration.
    Note: This method ignores subsequent entity declarations.
    Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
    
    Parameters:
    name - The name of the entity.
    text - The text of the entity.
    See Also:
    SymbolTable
  - addExternalEntity
```
public void addExternalEntity(String name,
                     String publicId,
                     String literalSystemId,
                     String baseSystemId)
                       throws IOException
```
    Adds an external entity declaration.
    Note: This method ignores subsequent entity declarations.
    Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
    
    Parameters:
    name - The name of the entity.
    publicId - The public identifier of the entity.
    literalSystemId - The system identifier of the entity.
    baseSystemId - The base system identifier of the entity. This is the system identifier of the entity where the entity being added and is used to expand the system identifier when the system identifier is a relative URI. When null the system identifier of the first external entity on the stack is used instead.
    
    Throws:
    
    IOException
    See Also:
    SymbolTable
  - addUnparsedEntity
```
public void addUnparsedEntity(String name,
                     String publicId,
                     String systemId,
                     String baseSystemId,
                     String notation)
```
    Adds an unparsed entity declaration.
    Note: This method ignores subsequent entity declarations.
    Note: The name should be a unique symbol. The SymbolTable can be used for this purpose.
    
    Parameters:
    name - The name of the entity.
    publicId - The public identifier of the entity.
    systemId - The system identifier of the entity.
    notation - The name of the notation.
    See Also:
    SymbolTable
  - getEntityStore
```
public XMLEntityStorage getEntityStore()
```
    get the entity storage object from entity manager
  - getEntityScanner
```
public XMLEntityScanner getEntityScanner()
```
    return the entity responsible for reading the entity
  - setScannerVersion
```
public void setScannerVersion(short version)
```
  - setupCurrentEntity
```
public String setupCurrentEntity(String name,
                        XMLInputSource xmlInputSource,
                        boolean literal,
                        boolean isExternal)
                          throws IOException,
                                 XNIException
```
    This method uses the passed-in XMLInputSource to make fCurrentEntity usable for reading.
    
    Parameters:
    name - name of the entity (XML is it's the document entity)
    xmlInputSource - the input source, with sufficient information to begin scanning characters.
    literal - True if this entity is started within a literal value.
    isExternal - whether this entity should be treated as an internal or external entity.
    
    Returns:
    the encoding of the new entity or null if a character stream was employed
    
    Throws:
    
    IOException - if anything can't be read XNIException If any parser-specific goes wrong.
    
    XNIException
  - isExternalEntity
```
public boolean isExternalEntity(String entityName)
```
    Checks whether an entity given by name is external.
    
    Parameters:
    entityName - The name of the entity to check.
    
    Returns:
    True if the entity is external, false otherwise (including when the entity is not declared).
  - isEntityDeclInExternalSubset
```
public boolean isEntityDeclInExternalSubset(String entityName)
```
    Checks whether the declaration of an entity given by name is // in the external subset.
    
    Parameters:
    entityName - The name of the entity to check.
    
    Returns:
    True if the entity was declared in the external subset, false otherwise (including when the entity is not declared).
  - setStandalone
```
public void setStandalone(boolean standalone)
```
    Sets whether the document entity is standalone.
    
    Parameters:
    standalone - True if document entity is standalone.
  - isStandalone
```
public boolean isStandalone()
```
    Returns true if the document entity is standalone.
  - isDeclaredEntity
```
public boolean isDeclaredEntity(String entityName)
```
  - isUnparsedEntity
```
public boolean isUnparsedEntity(String entityName)
```
  - getCurrentResourceIdentifier
```
public XMLResourceIdentifier getCurrentResourceIdentifier()
```
  - setEntityHandler
```
public void setEntityHandler(XMLEntityHandler entityHandler)
```
    Sets the entity handler. When an entity starts and ends, the entity handler is notified of the change.
    
    Parameters:
    entityHandler - The new entity handler.
  - resolveEntityAsPerStax
```
public StaxXMLInputSource resolveEntityAsPerStax(XMLResourceIdentifier resourceIdentifier)
                                          throws IOException
```
    Throws:
    
    IOException
  - resolveEntity
```
public XMLInputSource resolveEntity(XMLResourceIdentifier resourceIdentifier)
                             throws IOException,
                                    XNIException
```
    Resolves the specified public and system identifiers. This method first attempts to resolve the entity based on the EntityResolver registered by the application. If no entity resolver is registered or if the registered entity handler is unable to resolve the entity, then default entity resolution will occur.
    
    Specified by:
    
    resolveEntity in interface XMLEntityResolver
    
    Parameters:
    publicId - The public identifier of the entity.
    systemId - The system identifier of the entity.
    baseSystemId - The base system identifier of the entity. This is the system identifier of the current entity and is used to expand the system identifier when the system identifier is a relative URI.
    
    Returns:
    Returns an input source that wraps the resolved entity. This method will never return null.
    
    Throws:
    
    IOException - Thrown on i/o error.
    
    XNIException - Thrown by entity resolver to signal an error.
    See Also:
    XMLResourceIdentifier
  - startEntity
```
public void startEntity(String entityName,
               boolean literal)
                 throws IOException,
                        XNIException
```
    Starts a named entity.
    
    Parameters:
    entityName - The name of the entity to start.
    literal - True if this entity is started within a literal value.
    
    Throws:
    
    IOException - Thrown on i/o error.
    
    XNIException - Thrown by entity handler to signal an error.
  - startDocumentEntity
```
public void startDocumentEntity(XMLInputSource xmlInputSource)
                         throws IOException,
                                XNIException
```
    Starts the document entity. The document entity has the "[xml]" pseudo-name.
    
    Parameters:
    xmlInputSource - The input source of the document entity.
    
    Throws:
    
    IOException - Thrown on i/o error.
    
    XNIException - Thrown by entity handler to signal an error.
  - startDTDEntity
```
public void startDTDEntity(XMLInputSource xmlInputSource)
                    throws IOException,
                           XNIException
```
    Starts the DTD entity. The DTD entity has the "[dtd]" pseudo-name.
    
    Parameters:
    xmlInputSource - The input source of the DTD entity.
    
    Throws:
    
    IOException - Thrown on i/o error.
    
    XNIException - Thrown by entity handler to signal an error.
  - startExternalSubset
```
public void startExternalSubset()
```
  - endExternalSubset
```
public void endExternalSubset()
```
  - startEntity
```
public void startEntity(String name,
               XMLInputSource xmlInputSource,
               boolean literal,
               boolean isExternal)
                 throws IOException,
                        XNIException
```
    Starts an entity.
    This method can be used to insert an application defined XML entity stream into the parsing stream.
    
    Parameters:
    name - The name of the entity.
    xmlInputSource - The input source of the entity.
    literal - True if this entity is started within a literal value.
    isExternal - whether this entity should be treated as an internal or external entity.
    
    Throws:
    
    IOException - Thrown on i/o error.
    
    XNIException - Thrown by entity handler to signal an error.
  - getCurrentEntity
```
public Entity.ScannedEntity getCurrentEntity()
```
    Return the current entity being scanned. Current entity is SET using startEntity function.
    
    Returns:
    Entity.ScannedEntity
  - getTopLevelEntity
```
public Entity.ScannedEntity getTopLevelEntity()
```
    Return the top level entity handled by this manager, or null if no entity was added.
  - closeReaders
```
public void closeReaders()
```
    Close all opened InputStreams and Readers opened by this parser.
  - endEntity
```
public void endEntity()
               throws IOException,
                      XNIException
```
    Throws:
    
    IOException
    
    XNIException
  - reset
```
public void reset(PropertyManager propertyManager)
```
  - reset
```
public void reset(XMLComponentManager componentManager)
           throws XMLConfigurationException
```
    Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
    
    Specified by:
    
    reset in interface XMLComponent
    
    Parameters:
    componentManager - The component manager.
    
    Throws:
    
    SAXException - Thrown by component on initialization error. For example, if a feature or property is required for the operation of the component, the component manager may throw a SAXNotRecognizedException or a SAXNotSupportedException.
    
    XMLConfigurationException
  - reset
```
public void reset()
```
  - getRecognizedFeatures
```
public String[] getRecognizedFeatures()
```
    Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.
    
    Specified by:
    
    getRecognizedFeatures in interface XMLComponent
  - setFeature
```
public void setFeature(String featureId,
              boolean state)
                throws XMLConfigurationException
```
    Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.
    Note: Components should silently ignore features that do not affect the operation of the component.
    
    Specified by:
    
    setFeature in interface XMLComponent
    
    Parameters:
    featureId - The feature identifier.
    state - The state of the feature.
    
    Throws:
    
    SAXNotRecognizedException - The component should not throw this exception.
    
    SAXNotSupportedException - The component should not throw this exception.
    
    XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
  - setProperty
```
public void setProperty(String propertyId,
               Object value)
```
    Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.
    Note: Components should silently ignore properties that do not affect the operation of the component.
    
    Specified by:
    
    setProperty in interface XMLComponent
    
    Parameters:
    propertyId - The property identifier.
    value - The value of the property.
    
    Throws:
    
    SAXNotRecognizedException - The component should not throw this exception.
    
    SAXNotSupportedException - The component should not throw this exception.
  - setLimitAnalyzer
```
public void setLimitAnalyzer(XMLLimitAnalyzer fLimitAnalyzer)
```
  - getRecognizedProperties
```
public String[] getRecognizedProperties()
```
    Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.
    
    Specified by:
    
    getRecognizedProperties in interface XMLComponent
  - getFeatureDefault
```
public Boolean getFeatureDefault(String featureId)
```
    Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
    
    Specified by:
    
    getFeatureDefault in interface XMLComponent
    
    Parameters:
    featureId - The feature identifier.
    Since:
    
    Xerces 2.2.0
  - getPropertyDefault
```
public Object getPropertyDefault(String propertyId)
```
    Returns the default state for a property, or null if this component does not want to report a default value for this property.
    
    Specified by:
    
    getPropertyDefault in interface XMLComponent
    
    Parameters:
    propertyId - The property identifier.
    Since:
    
    Xerces 2.2.0
  - expandSystemId
```
public static String expandSystemId(String systemId)
```
    Expands a system id and returns the system id as a URI, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.
    
    Parameters:
    systemId - The systemId to be expanded.
    
    Returns:
    Returns the URI string representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.
  - absolutizeAgainstUserDir
```
public static void absolutizeAgainstUserDir(URI uri)
                                     throws URI.MalformedURIException
```
    Absolutizes a URI using the current value of the "user.dir" property as the base URI. If the URI is already absolute, this is a no-op.
    
    Parameters:
    uri - the URI to absolutize
    
    Throws:
    
    URI.MalformedURIException
  - expandSystemId
```
public static String expandSystemId(String systemId,
                    String baseSystemId)
```
    Expands a system id and returns the system id as a URI, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.
    
    Parameters:
    systemId - The systemId to be expanded.
    
    Returns:
    Returns the URI string representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.
  - expandSystemId
```
public static String expandSystemId(String systemId,
                    String baseSystemId,
                    boolean strict)
                             throws URI.MalformedURIException
```
    Expands a system id and returns the system id as a URI, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.
    
    Parameters:
    systemId - The systemId to be expanded.
    
    Returns:
    Returns the URI string representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.
    
    Throws:
    
    URI.MalformedURIException
  - setInstanceFollowRedirects
```
public static void setInstanceFollowRedirects(HttpURLConnection urlCon,
                              boolean followRedirects)
```
    Attempt to set whether redirects will be followed for an HttpURLConnection. This may fail on earlier JDKs which do not support setting this preference.
  - getEncodingName
```
protected Object[] getEncodingName(byte[] b4,
                       int count)
```
    Returns the IANA encoding name that is auto-detected from the bytes specified, with the endian-ness of that encoding where appropriate.
    
    Parameters:
    b4 - The first four bytes of the input.
    count - The number of bytes actually read.
    
    Returns:
    a 2-element array: the first element, an IANA-encoding string, the second element a Boolean which is true iff the document is big endian, false if it's little-endian, and null if the distinction isn't relevant.
  - createReader
```
protected Reader createReader(InputStream inputStream,
                  String encoding,
                  Boolean isBigEndian)
                       throws IOException
```
    Creates a reader capable of reading the given input stream in the specified encoding.
    
    Parameters:
    inputStream - The input stream.
    encoding - The encoding name that the input stream is encoded using. If the user has specified that Java encoding names are allowed, then the encoding name may be a Java encoding name; otherwise, it is an ianaEncoding name.
    isBigEndian - For encodings (like uCS-4), whose names cannot specify a byte order, this tells whether the order is bigEndian. null menas unknown or not relevant.
    
    Returns:
    Returns a reader.
    
    Throws:
    
    IOException
  - getPublicId
```
public String getPublicId()
```
    Return the public identifier for the current document event.
    The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.
    
    Returns:
    A string containing the public identifier, or null if none is available.
  - getExpandedSystemId
```
public String getExpandedSystemId()
```
    Return the expanded system identifier for the current document event.
    The return value is the expanded system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.
    If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
    
    Returns:
    A string containing the expanded system identifier, or null if none is available.
  - getLiteralSystemId
```
public String getLiteralSystemId()
```
    Return the literal system identifier for the current document event.
    The return value is the literal system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.
    
    Returns:
    A string containing the literal system identifier, or null if none is available.
  - getLineNumber
```
public int getLineNumber()
```
    Return the line number where the current document event ends.
    Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
    The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.
    If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line in the document is line 1.
    
    Returns:
    The line number, or -1 if none is available.
  - getColumnNumber
```
public int getColumnNumber()
```
    Return the column number where the current document event ends.
    Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
    The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.
    If possible, the SAX driver should provide the line position of the first character after the text associated with the document event.
    If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.
    
    Returns:
    The column number, or -1 if none is available.
  - fixURI
```
protected static String fixURI(String str)
```
    Fixes a platform dependent filename to standard URI form.
    
    Parameters:
    str - The string to fix.
    
    Returns:
    Returns the fixed URI string.
  - test
```
public void test()
```

Class XMLEntityManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_SIZE

DEFAULT_XMLDECL_BUFFER_SIZE

DEFAULT_INTERNAL_BUFFER_SIZE

VALIDATION

fStrictURI

EXTERNAL_GENERAL_ENTITIES

EXTERNAL_PARAMETER_ENTITIES

ALLOW_JAVA_ENCODINGS

WARN_ON_DUPLICATE_ENTITYDEF

LOAD_EXTERNAL_DTD

SYMBOL_TABLE

ERROR_REPORTER

STANDARD_URI_CONFORMANT

ENTITY_RESOLVER

STAX_ENTITY_RESOLVER

VALIDATION_MANAGER

BUFFER_SIZE

SECURITY_MANAGER

PARSER_SETTINGS

fWarnDuplicateEntityDef

fValidation

fExternalGeneralEntities

fExternalParameterEntities

fAllowJavaEncodings

fLoadExternalDTD

fSymbolTable

fErrorReporter

fEntityResolver

fStaxEntityResolver

fPropertyManager

fAccessExternalDTD

fValidationManager

fBufferSize

fSecurityManager

fLimitAnalyzer

entityExpansionIndex

fStandalone

fInExternalSubset

fEntityHandler

fEntityScanner

fXML10EntityScanner

fXML11EntityScanner

fEntityExpansionCount

fEntities

fEntityStack

fCurrentEntity

fEntityStorage

defaultEncoding

Constructor Detail

XMLEntityManager

XMLEntityManager

Method Detail

addInternalEntity

addExternalEntity

addUnparsedEntity

getEntityStore

getEntityScanner

setScannerVersion

setupCurrentEntity

isExternalEntity

isEntityDeclInExternalSubset

setStandalone

isStandalone

isDeclaredEntity

isUnparsedEntity

getCurrentResourceIdentifier

setEntityHandler

resolveEntityAsPerStax

resolveEntity

startEntity

startDocumentEntity

startDTDEntity

startExternalSubset