|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnu.xom.Node
nu.xom.LeafNode
nu.xom.DocType
This class represents an XML document type declaration such as
<!DOCTYPE book SYSTEM "docbookx.dtd">
Note that this is not the same thing as a document type definition (DTD). XOM does not currently model the DTD. The document type declaration contains or points to the DTD, but it is not the DTD.
A DocType
object does not have any child
nodes. It can be a child of a Document
.
Each DocType
object has four properties,
some of which may be null:
String
(which may be null).The first three properties are read-write. The internal DTD subset is read-only. XOM fills it in when a document is read by a parser. However, it cannot be changed, because XOM cannot currently check that an internal DTD subset is well-formed. This restriction may be relaxed in a future version.
Constructor Summary | |
DocType(DocType doctype)
Creates a new DocType that's a copy of its
argument. |
|
DocType(java.lang.String rootElementName)
Creates a new document type declaration with no public or system ID. |
|
DocType(java.lang.String rootElementName,
java.lang.String systemID)
Creates a new document type declaration with a system ID but no public ID. |
|
DocType(java.lang.String rootElementName,
java.lang.String publicID,
java.lang.String systemID)
Creates a new document type declaration with a system ID and a public ID It has the general form <!DOCTYPE rootElementName PUBLIC
"publicID" "systemID"> . |
Method Summary | |
protected void |
checkPublicID(java.lang.String publicID)
Subclasses can override this method to perform additional checks on the system ID beyond what XML 1.0 requires. |
protected void |
checkRootElementName(java.lang.String name)
Subclasses can override this method to perform additional checks on the root element name beyond what XML 1.0 requires. |
protected void |
checkSystemID(java.lang.String systemID)
Subclasses can override this method to perform additional checks on the system ID beyond what XML 1.0 requires. |
Node |
copy()
This method returns a copy of this DocType
which has the same system ID, public ID, root element name,
and internal DTD subset, but does not belong to a document. |
java.lang.String |
getInternalDTDSubset()
Returns complete internal DTD subset in a single string. |
java.lang.String |
getPublicID()
Returns the public ID of the external DTD subset. |
java.lang.String |
getRootElementName()
Returns the name the document type declaration specifies for the root element. |
java.lang.String |
getSystemID()
Returns the system ID of the external DTD subset. |
java.lang.String |
getValue()
Returns the empty string. |
void |
setPublicID(java.lang.String id)
Sets the public ID for the external DTD subset. |
void |
setRootElementName(java.lang.String name)
Sets the name the document type declaration specifies for the root element. |
void |
setSystemID(java.lang.String id)
Sets the system ID for the external DTD subset. |
java.lang.String |
toString()
This method returns a string form of the DocType suitable for debugging
and diagnosis. |
java.lang.String |
toXML()
Returns a string containing the actual XML form of the document type declaration represented by this object; for example, <!DOCTYPE book SYSTEM "docbookx.dtd"> . |
Methods inherited from class nu.xom.LeafNode |
getChild, getChildCount, hasChildren |
Methods inherited from class nu.xom.Node |
checkDetach, detach, equals, getBaseURI, getDocument, getParent, hashCode |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public DocType(java.lang.String rootElementName, java.lang.String publicID, java.lang.String systemID)
Creates a new document type declaration with a system ID
and a public ID It has the general form
<!DOCTYPE rootElementName PUBLIC
"publicID" "systemID">
.
rootElementName
- the name specified for the root elementpublicID
- the public ID of the external DTD subsetsystemID
- the URL of the external DTD subset
IllegalNameException
- if rootElementName
is not a legal XML 1.0 name
IllegalDataException
- if systemID
is not a legal XML 1.0 system literal or
publicID
is not a legal
XML 1.0 public identifierpublic DocType(java.lang.String rootElementName, java.lang.String systemID)
Creates a new document type declaration with a system ID
but no public ID. It has the general form
<!DOCTYPE rootElementName SYSTEM "systemID">
.
rootElementName
- the name specified for the root elementsystemID
- the URL of the external DTD subset
IllegalNameException
- if the rootElementName is not
a legal XML 1.0 name
IllegalDataException
- if the system ID is not
a legal XML 1.0 system literalpublic DocType(java.lang.String rootElementName)
Creates a new document type declaration with
no public or system ID. It has the general form
<!DOCTYPE rootElementName >
.
rootElementName
- the name specified for the root element
IllegalNameException
- if the rootElementName is not
a legal XML 1.0 namepublic DocType(DocType doctype)
Creates a new DocType
that's a copy of its
argument. The copy has the same data but no parent document.
doctype
- the DocType to copyMethod Detail |
public final void setRootElementName(java.lang.String name)
Sets the name the document type declaration specifies for the root element. In an invalid document, this may not be the same as the actual root element name.
name
- the root element name given by
the document type declaration
IllegalNameException
- if the rootElementName is not
a legal XML 1.0 namepublic final java.lang.String getRootElementName()
Returns the name the document type declaration specifies for the root element. In an invalid document, this may not be the same as the actual root element name.
public final java.lang.String getInternalDTDSubset()
Returns complete internal DTD subset in a single string. White space may not be preserved completely accurately, but all declarations should be in place.
public final void setPublicID(java.lang.String id)
Sets the public ID for the external DTD subset. This can only be set after a system ID has been set, because XML requires that all document type declarations with public IDs have system IDs. Passing null removes the public ID.
id
- the public identifier of the external DTD subset
IllegalDataException
- if the public ID does not satisfy
the rules for public IDs in XML 1.0
WellformednessException
- if no system ID has been setpublic final java.lang.String getPublicID()
Returns the public ID of the external DTD subset. This is null if there is no external DTD subset or if it does not have a public identifier.
public final void setSystemID(java.lang.String id)
Sets the system ID for the external DTD subset.
This is normally a relative or absolute URL.
Passing null removes the system ID, but only if the
public ID has been removed first. Otherwise,
passing null causes a WellformednessException
.
id
- the URL of the external DTD subset
IllegalDataException
- if the system ID is not a legal
XML 1.0 system literal
WellformednessException
- if the public ID is non-null
and you attempt to remove the system IDpublic final java.lang.String getSystemID()
Returns the system ID of the external DTD subset. This is a URL. It is null if there is no external DTD subset.
protected void checkRootElementName(java.lang.String name)
Subclasses can override this method to perform additional checks on the root element name beyond what XML 1.0 requires. For example, an HTMLDocType subclass might throw an exception if any name other than "html" were passed to this method. However, this can only be used to add checks, not remove them. All document type declarations must be potentially well-formed when serialized.
name
- The root element name specified
by the document type declaration.
XMLException
- if the proposed root element name
does not satisfy the local constraintsprotected void checkSystemID(java.lang.String systemID)
Subclasses can override this method to perform additional checks on the system ID beyond what XML 1.0 requires. For example, it might wish to check that the URL scheme is recognized. However, this can only be used to add checks, not remove them. All document type declarations must be potentially well-formed when serialized.
systemID
- The URL of the external DTD subset.
XMLException
- if the proposed system ID
does not satisfy the local constraintsprotected void checkPublicID(java.lang.String publicID)
Subclasses can override this method to perform additional
checks on the system ID beyond what XML 1.0 requires.
For example, an HTMLDocType
subclass might
check that the public ID were one of the three IDs
defined by the XHTML 1.0 specification. However, this can only
be used to add checks, not remove them. All document type
declarations must be potentially well-formed when serialized.
publicID
- The proposed public ID for the external
DTD subset.
XMLException
- if the proposed public ID
does not satisfy the local constraintspublic final java.lang.String getValue()
Returns the empty string. XPath 1.0 does not define a value for document type declarations.
getValue
in class Node
Node.getValue()
public final java.lang.String toString()
This method returns a string form of the
DocType
suitable for debugging
and diagnosis. It deliberately does not return
an actual XML document type declaration.
toString
in class Node
Node.toString()
public Node copy()
This method returns a copy of this DocType
which has the same system ID, public ID, root element name,
and internal DTD subset, but does not belong to a document.
Thus, it can be inserted into a different document.
copy
in class Node
DocType
that is not part of a documentNode.copy()
public final java.lang.String toXML()
Returns a string containing the actual XML
form of the document type declaration represented
by this object; for example,
<!DOCTYPE book SYSTEM "docbookx.dtd">
.
toXML
in class Node
String
containing
an XML document type declarationNode.toXML()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |