public class DOMInputImpl
extends java.lang.Object
implements org.w3c.dom.ls.LSInput
DOMInputImpl
represents a single input source for an XML entity.
This Class allows an application to encapsulate information about an input source in a single object, which may include a public identifier, a system identifier, a byte stream (possibly with a specified encoding), and/or a character stream.
The exact definitions of a byte stream and a character stream are binding dependent.
There are two places that the application will deliver this input
source to the parser: as the argument to the parse
method,
or as the return value of the DOMResourceResolver.resolveEntity
method.
The DOMParser
will use the LSInput
object to determine how to read XML input. If there is a character stream
available, the parser will read that stream directly; if not, the parser
will use a byte stream, if available; if neither a character stream nor a
byte stream is available, the parser will attempt to open a URI
connection to the resource identified by the system identifier.
An LSInput
object belongs to the application: the
parser shall never modify it in any way (it may modify a copy if
necessary). Eventhough all attributes in this interface are writable the
DOM implementation is expected to never mutate a LSInput.
See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load and Save Specification.
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
fBaseSystemId |
protected java.io.InputStream |
fByteStream |
protected boolean |
fCertifiedText |
protected java.io.Reader |
fCharStream |
protected java.lang.String |
fData |
protected java.lang.String |
fEncoding |
protected java.lang.String |
fPublicId |
protected java.lang.String |
fSystemId |
Constructor and Description |
---|
DOMInputImpl()
Default Constructor, constructs an input source
|
DOMInputImpl(java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId)
Constructs an input source from just the public and system
identifiers, leaving resolution of the entity and opening of
the input stream up to the caller.
|
DOMInputImpl(java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.io.InputStream byteStream,
java.lang.String encoding)
Constructs an input source from a byte stream.
|
DOMInputImpl(java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.io.Reader charStream,
java.lang.String encoding)
Constructs an input source from a character stream.
|
DOMInputImpl(java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.lang.String data,
java.lang.String encoding)
Constructs an input source from a String.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBaseURI()
The base URI to be used (see section 5.1.4 in ) for resolving relative
URIs to absolute URIs.
|
java.io.InputStream |
getByteStream()
An attribute of a language-binding dependent type that represents a
stream of bytes.
|
boolean |
getCertifiedText()
|
java.io.Reader |
getCharacterStream()
An attribute of a language-binding dependent type that represents a
stream of 16-bit units.
|
java.lang.String |
getEncoding()
The character encoding, if known.
|
java.lang.String |
getPublicId()
The public identifier for this input source.
|
java.lang.String |
getStringData()
A string attribute that represents a sequence of 16 bit units (utf-16
encoded characters).
|
java.lang.String |
getSystemId()
The system identifier, a URI reference , for this input source.
|
void |
setBaseURI(java.lang.String baseURI)
The base URI to be used (see section 5.1.4 in ) for resolving relative
URIs to absolute URIs.
|
void |
setByteStream(java.io.InputStream byteStream)
An attribute of a language-binding dependent type that represents a
stream of bytes.
|
void |
setCertifiedText(boolean certifiedText)
|
void |
setCharacterStream(java.io.Reader characterStream)
An attribute of a language-binding dependent type that represents a
stream of 16-bit units.
|
void |
setEncoding(java.lang.String encoding)
The character encoding, if known.
|
void |
setPublicId(java.lang.String publicId)
The public identifier for this input source.
|
void |
setStringData(java.lang.String stringData)
A string attribute that represents a sequence of 16 bit units (utf-16
encoded characters).
|
void |
setSystemId(java.lang.String systemId)
The system identifier, a URI reference , for this input source.
|
protected java.lang.String fPublicId
protected java.lang.String fSystemId
protected java.lang.String fBaseSystemId
protected java.io.InputStream fByteStream
protected java.io.Reader fCharStream
protected java.lang.String fData
protected java.lang.String fEncoding
protected boolean fCertifiedText
public DOMInputImpl()
public DOMInputImpl(java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId)
publicId
- The public identifier, if known.systemId
- The system identifier. This value should
always be set, if possible, and can be
relative or absolute. If the system identifier
is relative, then the base system identifier
should be set.baseSystemId
- The base system identifier. This value should
always be set to the fully expanded URI of the
base system identifier, if possible.public DOMInputImpl(java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.io.InputStream byteStream, java.lang.String encoding)
publicId
- The public identifier, if known.systemId
- The system identifier. This value should
always be set, if possible, and can be
relative or absolute. If the system identifier
is relative, then the base system identifier
should be set.baseSystemId
- The base system identifier. This value should
always be set to the fully expanded URI of the
base system identifier, if possible.byteStream
- The byte stream.encoding
- The encoding of the byte stream, if known.public DOMInputImpl(java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.io.Reader charStream, java.lang.String encoding)
publicId
- The public identifier, if known.systemId
- The system identifier. This value should
always be set, if possible, and can be
relative or absolute. If the system identifier
is relative, then the base system identifier
should be set.baseSystemId
- The base system identifier. This value should
always be set to the fully expanded URI of the
base system identifier, if possible.charStream
- The character stream.encoding
- The original encoding of the byte stream
used by the reader, if known.public DOMInputImpl(java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String data, java.lang.String encoding)
publicId
- The public identifier, if known.systemId
- The system identifier. This value should
always be set, if possible, and can be
relative or absolute. If the system identifier
is relative, then the base system identifier
should be set.baseSystemId
- The base system identifier. This value should
always be set to the fully expanded URI of the
base system identifier, if possible.data
- The String Data.encoding
- The original encoding of the byte stream
used by the reader, if known.public java.io.InputStream getByteStream()
getByteStream
in interface org.w3c.dom.ls.LSInput
public void setByteStream(java.io.InputStream byteStream)
setByteStream
in interface org.w3c.dom.ls.LSInput
public java.io.Reader getCharacterStream()
getCharacterStream
in interface org.w3c.dom.ls.LSInput
public void setCharacterStream(java.io.Reader characterStream)
setCharacterStream
in interface org.w3c.dom.ls.LSInput
public java.lang.String getStringData()
getStringData
in interface org.w3c.dom.ls.LSInput
public void setStringData(java.lang.String stringData)
setStringData
in interface org.w3c.dom.ls.LSInput
public java.lang.String getEncoding()
getEncoding
in interface org.w3c.dom.ls.LSInput
public void setEncoding(java.lang.String encoding)
setEncoding
in interface org.w3c.dom.ls.LSInput
public java.lang.String getPublicId()
getPublicId
in interface org.w3c.dom.ls.LSInput
public void setPublicId(java.lang.String publicId)
setPublicId
in interface org.w3c.dom.ls.LSInput
public java.lang.String getSystemId()
getSystemId
in interface org.w3c.dom.ls.LSInput
public void setSystemId(java.lang.String systemId)
setSystemId
in interface org.w3c.dom.ls.LSInput
public java.lang.String getBaseURI()
getBaseURI
in interface org.w3c.dom.ls.LSInput
public void setBaseURI(java.lang.String baseURI)
setBaseURI
in interface org.w3c.dom.ls.LSInput
public boolean getCertifiedText()
getCertifiedText
in interface org.w3c.dom.ls.LSInput
Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.