All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.jclark.xml.parse.OpenEntity

java.lang.Object
   |
   +----com.jclark.xml.parse.OpenEntity

public class OpenEntity
extends Object
Information about an open external entity. This is used to by EntityManager to return information about an external entity that is has opened.

See Also:
EntityManager

Constructor Index

 o OpenEntity(InputStream, String, URL)
Creates and initializes an OpenEntity which uses the encoding specified in the entity.
 o OpenEntity(InputStream, String, URL, String)
Creates and initializes an OpenEntity which uses an externally specified encoding.

Method Index

 o getBase()
Returns the URL to use as the base URL for resolving relative URLs contained in the entity.
 o getEncoding()
Returns the name of the encoding to be used to convert the entity's bytes into characters, or null if this should be determined from the entity itself using XML's rules.
 o getInputStream()
Returns an InputStream containing the entity's bytes.
 o getLocation()
Returns a string representation of the location of the entity suitable for use in error messages.

Constructors

 o OpenEntity
 public OpenEntity(InputStream inputStream,
                   String location,
                   URL base,
                   String encoding)
Creates and initializes an OpenEntity which uses an externally specified encoding.

 o OpenEntity
 public OpenEntity(InputStream inputStream,
                   String location,
                   URL base)
Creates and initializes an OpenEntity which uses the encoding specified in the entity.

Methods

 o getInputStream
 public final InputStream getInputStream()
Returns an InputStream containing the entity's bytes. If this is called more than once on the same OpenEntity, it will return the same InputStream.

 o getEncoding
 public final String getEncoding()
Returns the name of the encoding to be used to convert the entity's bytes into characters, or null if this should be determined from the entity itself using XML's rules.

 o getBase
 public final URL getBase()
Returns the URL to use as the base URL for resolving relative URLs contained in the entity.

 o getLocation
 public final String getLocation()
Returns a string representation of the location of the entity suitable for use in error messages.


All Packages  Class Hierarchy  This Package  Previous  Next  Index