A DOM document node implemented in libxml2.
adoptNode
public Node adoptNode(Node source)
throws DOMException
Attempts to adopt a node from another document to this document. If
supported, it changes the
ownerDocument
of the source
node, its children, as well as the attached attribute nodes if there
are any. If the source node has a parent it is first removed from the
child list of its parent. This effectively allows moving a subtree
from one document to another (unlike
importNode()
which
create a copy of the source node instead of moving it). When it
fails, applications should use
Document.importNode()
instead. Note that if the adopted node is already part of this
document (i.e. the source and target document are the same), this
method still has the effect of removing the source node from the
child list of its parent, if any. The following list describes the
specifics for each type of node.
ownerElement
null
specified
true
Attr
Attr
Document
DocumentType
- Specified
Entity
EntityReference
Notation
Note: Since it does not create new nodes unlike the
Document.importNode()
method, this method does not raise
an
INVALID_CHARACTER_ERR
exception, and applications
should use the
Document.normalizeDocument()
method to
check if an imported name is not an XML name according to the XML
version in use.
- adoptNode in interface Document
source
- The node to move into this document.
- The adopted node, or
null
if this operation
fails, such as when the source node comes from a different
implementation.
DOMException
- NOT_SUPPORTED_ERR: Raised if the source node is of type
DOCUMENT
, DOCUMENT_TYPE
.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is
readonly.
createAttribute
public Attr createAttribute(String name)
throws DOMException
Creates an Attr
of the given name. Note that the
Attr
instance can then be set on an Element
using the setAttributeNode
method.
To create an attribute with a qualified name and namespace URI, use
the createAttributeNS
method.
- createAttribute in interface Document
name
- The name of the attribute.
- A new
Attr
object with the nodeName
attribute set to name
, and localName
,
prefix
, and namespaceURI
set to
null
. The value of the attribute is the empty string.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
createAttributeNS
public Attr createAttributeNS(String namespaceURI,
String qualifiedName)
throws DOMException
Creates an attribute of the given qualified name and namespace URI.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI
parameter for methods if they wish to have
no namespace.
- createAttributeNS in interface Document
namespaceURI
- The namespace URI of the attribute to create.qualifiedName
- The qualified name of the attribute to
instantiate.
- A new
Attr
object with the following attributes:
Attribute | Value |
---|
Node.nodeName | qualifiedName |
Node.namespaceURI | namespaceURI |
Node.prefix | prefix, extracted from
qualifiedName , or null if there is no
prefix |
Node.localName | local name, extracted from
qualifiedName |
Attr.name |
qualifiedName |
Node.nodeValue | the empty
string |
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
qualifiedName
is not an XML name according to the XML
version in use specified in the Document.xmlVersion
attribute.
NAMESPACE_ERR: Raised if the qualifiedName
is a
malformed qualified name, if the qualifiedName
has a
prefix and the namespaceURI
is null
, if
the qualifiedName
has a prefix that is "xml" and the
namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace", if the qualifiedName
or its prefix is "xmlns" and the
namespaceURI
is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI
is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not
support the "XML"
feature, since namespaces were
defined by XML.
createElement
public Element createElement(String tagName)
throws DOMException
Creates an element of the type specified. Note that the instance
returned implements the Element
interface, so attributes
can be specified directly on the returned object.
In addition, if there are known attributes with default values,
Attr
nodes representing them are automatically created
and attached to the element.
To create an element with a qualified name and namespace URI, use
the createElementNS
method.
- createElement in interface Document
tagName
- The name of the element type to instantiate. For XML,
this is case-sensitive, otherwise it depends on the
case-sensitivity of the markup language in use. In that case, the
name is mapped to the canonical form of that markup by the DOM
implementation.
- A new
Element
object with the
nodeName
attribute set to tagName
, and
localName
, prefix
, and
namespaceURI
set to null
.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
createElementNS
public Element createElementNS(String namespaceURI,
String qualifiedName)
throws DOMException
Creates an element of the given qualified name and namespace URI.
Per [
XML Namespaces]
, applications must use the value
null
as the
namespaceURI parameter for methods if they wish to have no namespace.
- createElementNS in interface Document
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to
instantiate.
- A new
Element
object with the following
attributes:
Attribute | Value |
---|
Node.nodeName |
qualifiedName |
Node.namespaceURI |
namespaceURI |
Node.prefix | prefix, extracted
from qualifiedName , or null if there is
no prefix |
Node.localName | local name, extracted from
qualifiedName |
Element.tagName |
qualifiedName |
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
qualifiedName
is not an XML name according to the XML
version in use specified in the Document.xmlVersion
attribute.
NAMESPACE_ERR: Raised if the qualifiedName
is a
malformed qualified name, if the qualifiedName
has a
prefix and the namespaceURI
is null
, or
if the qualifiedName
has a prefix that is "xml" and
the namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace" [XML Namespaces]
, or if the qualifiedName
or its prefix is "xmlns" and
the namespaceURI
is different from "http://www.w3.org/2000/xmlns/", or if the namespaceURI
is "http://www.w3.org/2000/xmlns/" and neither the qualifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not
support the "XML"
feature, since namespaces were
defined by XML.
createEntityReference
public EntityReference createEntityReference(String name)
throws DOMException
Creates an
EntityReference
object. In addition, if the
referenced entity is known, the child list of the
EntityReference
node is made the same as that of the
corresponding
Entity
node.
Note: If any descendant of the
Entity
node has
an unbound namespace prefix, the corresponding descendant of the
created
EntityReference
node is also unbound; (its
namespaceURI
is
null
). The DOM Level 2 and
3 do not support any mechanism to resolve namespace prefixes in this
case.
- createEntityReference in interface Document
name
- The name of the entity to reference.Unlike
Document.createElementNS
or
Document.createAttributeNS
, no namespace well-formed
checking is done on the entity name. Applications should invoke
Document.normalizeDocument()
with the parameter "
namespaces" set to true
in order to ensure that the
entity name is namespace well-formed.
- The new
EntityReference
object.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
createExpression
public XPathExpression createExpression(String expression,
XPathNSResolver resolver)
throws XPathException,
DOMException
Creates a parsed XPath expression with resolved namespaces. This is
useful when an expression will be reused in an application since it
makes it possible to compile the expression string into a more
efficient internal form and preresolve all namespace prefixes which
occur within the expression.
- createExpression in interface XPathEvaluator
expression
- The XPath expression string to be parsed.resolver
- The resolver
permits translation of all
prefixes, including the xml
namespace prefix, within
the XPath expression into appropriate namespace URIs. If this is
specified as null
, any namespace prefix within the
expression will result in DOMException
being thrown
with the code NAMESPACE_ERR
.
- The compiled form of the XPath expression.
XPathException
- INVALID_EXPRESSION_ERR: Raised if the expression is not legal
according to the rules of the XPathEvaluator
.DOMException
- NAMESPACE_ERR: Raised if the expression contains namespace prefixes
which cannot be resolved by the specified
XPathNSResolver
.
createNSResolver
public XPathNSResolver createNSResolver(Node nodeResolver)
Adapts any DOM node to resolve namespaces so that an XPath expression
can be easily evaluated relative to the context of the node where it
appeared within the document. This adapter works like the DOM Level 3
method lookupNamespaceURI
on nodes in resolving the
namespaceURI from a given prefix using the current information
available in the node's hierarchy at the time lookupNamespaceURI is
called. also correctly resolving the implicit xml prefix.
- createNSResolver in interface XPathEvaluator
nodeResolver
- The node to be used as a context for namespace
resolution.
XPathNSResolver
which resolves namespaces with
respect to the definitions in scope for a specified node.
createProcessingInstruction
public ProcessingInstruction createProcessingInstruction(String target,
String data)
throws DOMException
Creates a ProcessingInstruction
node given the specified
name and data strings.
- createProcessingInstruction in interface Document
target
- The target part of the processing instruction.Unlike
Document.createElementNS
or
Document.createAttributeNS
, no namespace well-formed
checking is done on the target name. Applications should invoke
Document.normalizeDocument()
with the parameter "
namespaces" set to true
in order to ensure that the
target name is namespace well-formed.data
- The data for the node.
- The new
ProcessingInstruction
object.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified target is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
evaluate
public Object evaluate(String expression,
Node contextNode,
XPathNSResolver resolver,
short type,
Object result)
throws XPathException,
DOMException
Evaluates an XPath expression string and returns a result of the
specified type if possible.
- evaluate in interface XPathEvaluator
expression
- The XPath expression string to be parsed and
evaluated.contextNode
- The context
is context node for the
evaluation of this XPath expression. If the XPathEvaluator was
obtained by casting the Document
then this must be
owned by the same document and must be a Document
,
Element
, Attribute
, Text
,
CDATASection
, Comment
,
ProcessingInstruction
, or XPathNamespace
node. If the context node is a Text
or a
CDATASection
, then the context is interpreted as the
whole logical text node as seen by XPath, unless the node is empty
in which case it may not serve as the XPath context.resolver
- The resolver
permits translation of all
prefixes, including the xml
namespace prefix, within
the XPath expression into appropriate namespace URIs. If this is
specified as null
, any namespace prefix within the
expression will result in DOMException
being thrown
with the code NAMESPACE_ERR
.type
- If a specific type
is specified, then the
result will be returned as the corresponding type.For XPath 1.0
results, this must be one of the codes of the
XPathResult
interface.result
- The result
specifies a specific result
object which may be reused and returned by this method. If this is
specified as null
or the implementation does not reuse
the specified result, a new result object will be constructed and
returned.For XPath 1.0 results, this object will be of type
XPathResult
.
- The result of the evaluation of the XPath expression.For XPath
1.0 results, this object will be of type
XPathResult
.
XPathException
- INVALID_EXPRESSION_ERR: Raised if the expression is not legal
according to the rules of the XPathEvaluator
i
TYPE_ERR: Raised if the result cannot be converted to return the
specified type.DOMException
- NAMESPACE_ERR: Raised if the expression contains namespace prefixes
which cannot be resolved by the specified
XPathNSResolver
.
WRONG_DOCUMENT_ERR: The Node is from a document that is not
supported by this XPathEvaluator
.
NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath
context node or the request type is not permitted by this
XPathEvaluator
.
finalize
protected void finalize()
Called on an object by the Virtual Machine at most once,
at some point after the Object is determined unreachable
but before it is destroyed. You would think that this
means it eventually is called on every Object, but this is
not necessarily the case. If execution terminates
abnormally, garbage collection does not always happen.
Thus you cannot rely on this method to always work.
For finer control over garbage collection, use references
from the
java.lang.ref
package.
Virtual Machines are free to not call this method if
they can determine that it does nothing important; for
example, if your class extends Object and overrides
finalize to do simply
super.finalize()
.
finalize() will be called by a
Thread
that has no
locks on any Objects, and may be called concurrently.
There are no guarantees on the order in which multiple
objects are finalized. This means that finalize() is
usually unsuited for performing actions that must be
thread-safe, and that your implementation must be
use defensive programming if it is to always work.
If an Exception is thrown from finalize() during garbage
collection, it will be patently ignored and the Object will
still be destroyed.
It is allowed, although not typical, for user code to call
finalize() directly. User invocation does not affect whether
automatic invocation will occur. It is also permitted,
although not recommended, for a finalize() method to "revive"
an object by making it reachable from normal code again.
Unlike constructors, finalize() does not get called
for an object's superclass unless the implementation
specifically calls
super.finalize()
.
The default implementation does nothing.
- finalize in interface Object
getDoctype
public DocumentType getDoctype()
The Document Type Declaration (see
DocumentType
)
associated with this document. For XML documents without a document
type declaration this returns
null
. For HTML documents,
a
DocumentType
object may be returned, independently of
the presence or absence of document type declaration in the HTML
document.
This provides direct access to the
DocumentType
node,
child node of this
Document
. This node can be set at
document creation time and later changed through the use of child
nodes manipulation methods, such as
Node.insertBefore
,
or
Node.replaceChild
. Note, however, that while some
implementations may instantiate different types of
Document
objects supporting additional features than the
"Core", such as "HTML" [
DOM Level 2 HTML]
, based on the
DocumentType
specified at creation time,
changing it afterwards is very unlikely to result in a change of the
features supported.
- getDoctype in interface Document
getDocumentURI
public String getDocumentURI()
The location of the document or
null
if undefined or if
the
Document
was created using
DOMImplementation.createDocument
. No lexical checking is
performed when setting this attribute; this could result in a
null
value returned when using
Node.baseURI
.
Beware that when the
Document
supports the feature
"HTML" [
DOM Level 2 HTML]
, the href attribute of the HTML BASE element takes precedence over
this attribute when computing
Node.baseURI
.
- getDocumentURI in interface Document
getElementById
public Element getElementById(String elementId)
Returns the
Element
that has an ID attribute with the
given value. If no such element exists, this returns
null
. If more than one element has an ID attribute with that value, what
is returned is undefined.
The DOM implementation is expected to use the attribute
Attr.isId
to determine if an attribute is of type ID.
Note: Attributes with the name "ID" or "id" are not of type
ID unless so defined.
- getElementById in interface Document
elementId
- The unique id
value for an element.
- The matching element or
null
if there is none.
getElementsByTagNameNS
public NodeList getElementsByTagNameNS(String namespaceURI,
String localName)
Returns a NodeList
of all the Elements
with a
given local name and namespace URI in document order.
- getElementsByTagNameNS in interface Document
namespaceURI
- The namespace URI of the elements to match on. The
special value "*"
matches all namespaces.localName
- The local name of the elements to match on. The
special value "*" matches all local names.
- A new
NodeList
object containing all the matched
Elements
.
getInputEncoding
public String getInputEncoding()
An attribute specifying the encoding used for this document at the time
of the parsing. This is null
when it is not known, such
as when the Document
was created in memory.
- getInputEncoding in interface Document
getStrictErrorChecking
public boolean getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not. When
set to false
, the implementation is free to not test
every possible error case normally defined on DOM operations, and not
raise any DOMException
on DOM operations or report
errors while using Document.normalizeDocument()
. In case
of error, the behavior is undefined. This attribute is
true
by default.
- getStrictErrorChecking in interface Document
getXmlVersion
public String getXmlVersion()
An attribute specifying, as part of the
XML declaration, the version number of this document. If there is no declaration and if
this document supports the "XML" feature, the value is
"1.0"
. If this document does not support the "XML"
feature, the value is always
null
. Changing this
attribute will affect methods that check for invalid characters in
XML names. Application should invoke
Document.normalizeDocument()
in order to check for
invalid characters in the
Node
s that are already part of
this
Document
.
DOM applications may use the
DOMImplementation.hasFeature(feature, version)
method
with parameter values "XMLVersion" and "1.0" (respectively) to
determine if an implementation supports [
XML 1.0]. DOM
applications may use the same method with parameter values
"XMLVersion" and "1.1" (respectively) to determine if an
implementation supports [
XML 1.1]. In both
cases, in order to support XML, an implementation must also support
the "XML" feature defined in this specification.
Document
objects supporting a version of the "XMLVersion" feature must not
raise a
NOT_SUPPORTED_ERR
exception for the same version
number when using
Document.xmlVersion
.
- getXmlVersion in interface Document
importNode
public Node importNode(Node importedNode,
boolean deep)
throws DOMException
Imports a node from another document to this document, without altering
or removing the source node from the original document; this method
creates a new copy of the source node. The returned node has no
parent; (
parentNode
is
null
).
For all nodes, importing a node creates a node object owned by the
importing document, with attribute values identical to the source
node's
nodeName
and
nodeType
, plus the
attributes related to namespaces (
prefix
,
localName
, and
namespaceURI
). As in the
cloneNode
operation, the source node is not altered.
User data associated to the imported node is not carried over.
However, if any
UserDataHandlers
has been specified
along with the associated data these handlers will be called with the
appropriate parameters before this method returns.
Additional information is copied as appropriate to the
nodeType
, attempting to mirror the behavior expected if
a fragment of XML or HTML source was copied from one document to
another, recognizing that the two documents may have different DTDs
in the XML case. The following list describes the specifics for each
type of node.
ownerElement
null
specified
true
Attr
Attr
deep
Attr
deep
true
DocumentFragment
DocumentFragment
DocumentFragment
Document
DocumentType
- Specified
Attr
Element
notimportNode
deep
true
Entity
DocumentType
DocumentType
publicId
systemId
notationName
deep
Entity
EntityReference
deep
Notation
DocumentType
DocumentType
publicId
systemId
deep
target
data
deep
CharacterData
data
length
deep
- importNode in interface Document
importedNode
- The node to import.deep
- If true
, recursively import the subtree under
the specified node; if false
, import only the node
itself, as explained above. This has no effect on nodes that cannot
have any children, and on Attr
, and
EntityReference
nodes.
- The imported node that belongs to this
Document
.
DOMException
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
supported.
INVALID_CHARACTER_ERR: Raised if one of the imported names is not
an XML name according to the XML version in use specified in the
Document.xmlVersion
attribute. This may happen when
importing an XML 1.1 [XML 1.1] element
into an XML 1.0 document, for instance.
normalizeDocument
public void normalizeDocument()
This method acts as if the document was going through a save and load
cycle, putting the document in a "normal" form. As a consequence,
this method updates the replacement tree of
EntityReference
nodes and normalizes
Text
nodes, as defined in the method
Node.normalize()
.
Otherwise, the actual result depends on the features being set on
the
Document.domConfig
object and governing what
operations actually take place. Noticeably this method could also
make the document namespace well-formed according to the algorithm
described in , check the character normalization, remove the
CDATASection
nodes, etc. See
DOMConfiguration
for details.
// Keep in the document
the information defined // in the XML Information Set (Java example)
DOMConfiguration docConfig = myDocument.getDomConfig();
docConfig.setParameter("infoset", Boolean.TRUE);
myDocument.normalizeDocument();
Mutation events, when supported, are generated to reflect the
changes occurring on the document.
If errors occur during the invocation of this method, such as an
attempt to update a read-only node or a
Node.nodeName
contains an invalid character according to the XML version in use,
errors or warnings (
DOMError.SEVERITY_ERROR
or
DOMError.SEVERITY_WARNING
) will be reported using the
DOMErrorHandler
object associated with the "error-handler
" parameter. Note this method might also report fatal errors (
DOMError.SEVERITY_FATAL_ERROR
) if an implementation
cannot recover from an error.
- normalizeDocument in interface Document
renameNode
public Node renameNode(Node n,
String namespaceURI,
String qualifiedName)
Rename an existing node of type
ELEMENT_NODE
or
ATTRIBUTE_NODE
.
When possible this simply changes the name of the given node,
otherwise this creates a new node with the specified name and
replaces the existing node with the new node as described below.
If simply changing the name of the given node is not possible, the
following operations are performed: a new node is created, any
registered event listener is registered on the new node, any user
data attached to the old node is removed from that node, the old node
is removed from its parent if it has one, the children are moved to
the new node, if the renamed node is an
Element
its
attributes are moved to the new node, the new node is inserted at the
position the old node used to have in its parent's child nodes list
if it has one, the user data that was attached to the old node is
attached to the new node.
When the node being renamed is an
Element
only the
specified attributes are moved, default attributes originated from
the DTD are updated according to the new element name. In addition,
the implementation may update default attributes from other schemas.
Applications should use
Document.normalizeDocument()
to
guarantee these attributes are up-to-date.
When the node being renamed is an
Attr
that is
attached to an
Element
, the node is first removed from
the
Element
attributes map. Then, once renamed, either
by modifying the existing node or creating a new one as described
above, it is put back.
In addition,
- a user data event
NODE_RENAMED
is fired,
-
when the implementation supports the feature "MutationNameEvents",
each mutation operation involved in this method fires the appropriate
event, and in the end the event {
http://www.w3.org/2001/xml-events
,
DOMElementNameChanged
} or {
http://www.w3.org/2001/xml-events
,
DOMAttributeNameChanged
} is fired.
- renameNode in interface Document
n
- The node to rename.namespaceURI
- The new namespace URI.qualifiedName
- The new qualified name.
- The renamed node. This is either the specified node or the new
node that was created to replace the specified node.
DOMException
- NOT_SUPPORTED_ERR: Raised when the type of the specified node is
neither ELEMENT_NODE
nor ATTRIBUTE_NODE
,
or if the implementation does not support the renaming of the
document element.
INVALID_CHARACTER_ERR: Raised if the new qualified name is not an
XML name according to the XML version in use specified in the
Document.xmlVersion
attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created
from a different document than this document.
NAMESPACE_ERR: Raised if the qualifiedName
is a
malformed qualified name, if the qualifiedName
has a
prefix and the namespaceURI
is null
, or
if the qualifiedName
has a prefix that is "xml" and
the namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace" [XML Namespaces]
. Also raised, when the node being renamed is an attribute, if the
qualifiedName
, or its prefix, is "xmlns" and the
namespaceURI
is different from "http://www.w3.org/2000/xmlns/".
setDocumentURI
public void setDocumentURI(String documentURI)
The location of the document or
null
if undefined or if
the
Document
was created using
DOMImplementation.createDocument
. No lexical checking is
performed when setting this attribute; this could result in a
null
value returned when using
Node.baseURI
.
Beware that when the
Document
supports the feature
"HTML" [
DOM Level 2 HTML]
, the href attribute of the HTML BASE element takes precedence over
this attribute when computing
Node.baseURI
.
- setDocumentURI in interface Document
setStrictErrorChecking
public void setStrictErrorChecking(boolean strictErrorChecking)
An attribute specifying whether error checking is enforced or not. When
set to false
, the implementation is free to not test
every possible error case normally defined on DOM operations, and not
raise any DOMException
on DOM operations or report
errors while using Document.normalizeDocument()
. In case
of error, the behavior is undefined. This attribute is
true
by default.
- setStrictErrorChecking in interface Document
setXmlVersion
public void setXmlVersion(String xmlVersion)
An attribute specifying, as part of the
XML declaration, the version number of this document. If there is no declaration and if
this document supports the "XML" feature, the value is
"1.0"
. If this document does not support the "XML"
feature, the value is always
null
. Changing this
attribute will affect methods that check for invalid characters in
XML names. Application should invoke
Document.normalizeDocument()
in order to check for
invalid characters in the
Node
s that are already part of
this
Document
.
DOM applications may use the
DOMImplementation.hasFeature(feature, version)
method
with parameter values "XMLVersion" and "1.0" (respectively) to
determine if an implementation supports [
XML 1.0]. DOM
applications may use the same method with parameter values
"XMLVersion" and "1.1" (respectively) to determine if an
implementation supports [
XML 1.1]. In both
cases, in order to support XML, an implementation must also support
the "XML" feature defined in this specification.
Document
objects supporting a version of the "XMLVersion" feature must not
raise a
NOT_SUPPORTED_ERR
exception for the same version
number when using
Document.xmlVersion
.
- setXmlVersion in interface Document
DOMException
- NOT_SUPPORTED_ERR: Raised if the version is set to a value that is
not supported by this Document
or if this document
does not support the "XML" feature.
toString
public String toString()
Convert this Object to a human-readable String.
There are no limits placed on how long this String
should be or what it should contain. We suggest you
make it as intuitive as possible to be able to place
it into
System.out.println()
and such.
It is typical, but not required, to ensure that this method
never completes abruptly with a
RuntimeException
.
This method will be called when performing string
concatenation with this object. If the result is
null
, string concatenation will instead
use
"null"
.
The default implementation returns
getClass().getName() + "@" +
Integer.toHexString(hashCode())
.
- toString in interface gnu.xml.libxmlj.dom.GnomeNode
- the String representing this Object, which may be null
GnomeDocument.java -
Copyright (C) 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.