|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.jdom.Element
Element defines behavior for an XML
element, modeled in Java. Methods allow the user
to obtain the value of the element's textual content,
obtain its attributes, and get its children.
| Field Summary | |
protected List |
additionalNamespaces
Additional declarations on this
element |
protected List |
attributes
The attributes of the Element |
protected List |
content
The mixed content of the Element |
protected String |
name
The local name of the Element |
protected Namespace |
namespace
The of the Element |
protected Object |
parent
Parent element, document, or null if none |
| Constructor Summary | |
protected |
Element()
This protected constructor is provided in order to support an Element subclass that wants full control over variable initialization. |
|
Element(String name)
This will create an Element in no
. |
|
Element(String name,
Namespace namespace)
This will create a new Element
with the supplied (local) name, and define
the to be used. |
|
Element(String name,
String uri)
This will create a new Element with
the supplied (local) name, and specifies the URI
of the the Element
should be in, resulting it being unprefixed (in the default
namespace). |
|
Element(String name,
String prefix,
String uri)
This will create a new Element with
the supplied (local) name, and specifies the prefix and URI
of the the Element
should be in. |
| Method Summary | |
Element |
addAttribute(Attribute attribute)
Deprecated. Deprecated in beta7, use setAttribute(Attribute) instead |
Element |
addAttribute(String name,
String value)
Deprecated. Deprecated in beta7, use setAttribute(Attribute) instead |
Element |
addContent(CDATA cdata)
This adds a CDATA section as content to this element. |
Element |
addContent(Comment comment)
This adds a comment as content to this element. |
Element |
addContent(Element element)
This adds element content to this element. |
Element |
addContent(EntityRef entity)
This adds entity content to this element. |
Element |
addContent(ProcessingInstruction pi)
This adds a processing instruction as content to this element. |
Element |
addContent(String text)
This adds text content to this element. |
void |
addNamespaceDeclaration(Namespace additionalNamespace)
This will add a namespace declarations to this element. |
Object |
clone()
This returns a deep clone of this element. |
Element |
detach()
This detaches the element from its parent, or does nothing if the element has no parent. |
boolean |
equals(Object ob)
This tests for equality of this Element to the supplied
Object, explicitly using the == operator. |
List |
getAdditionalNamespaces()
This will return any namespace declarations on this element that exist, excluding the namespace of the element itself, which can be obtained through . |
Attribute |
getAttribute(String name)
This returns the attribute for this element with the given name and within no namespace. |
Attribute |
getAttribute(String name,
Namespace ns)
This returns the attribute for this element with the given name and within the given Namespace. |
List |
getAttributes()
This returns the complete set of attributes for this element, as a List of Attribute objects in no particular
order, or an empty list if there are none. |
String |
getAttributeValue(String name)
This returns the attribute value for the attribute with the given name and within no namespace, null if there is no such attribute, and the empty string if the attribute value is empty. |
String |
getAttributeValue(String name,
Namespace ns)
This returns the attribute value for the attribute with the given name and within the given Namespace, null if there is no such attribute, and the empty string if the attribute value is empty. |
Element |
getChild(String name)
This returns the first child element within this element with the given local name and belonging to no namespace. |
Element |
getChild(String name,
Namespace ns)
This returns the first child element within this element with the given local name and belonging to the given namespace. |
List |
getChildren()
This returns a List of all the child elements
nested directly (one level deep) within this element, as
Element objects. |
List |
getChildren(String name)
This returns a List of all the child elements
nested directly (one level deep) within this element with the given
local name and belonging to no namespace, returned as
Element objects. |
List |
getChildren(String name,
Namespace ns)
This returns a List of all the child elements
nested directly (one level deep) within this element with the given
local name and belonging to the given Namespace, returned as
Element objects. |
String |
getChildText(String name)
This convenience method returns the textual content of the named child element, or returns an empty String ("")
if the child has no textual content. |
String |
getChildText(String name,
Namespace ns)
This convenience method returns the textual content of the named child element, or returns null if there's no such child. |
String |
getChildTextTrim(String name)
This convenience method returns the trimmed textual content of the named child element, or returns null if there's no such child. |
String |
getChildTextTrim(String name,
Namespace ns)
This convenience method returns the trimmed textual content of the named child element, or returns null if there's no such child. |
List |
getContent()
This returns the full content of the element as a List which may contain objects of type String, Element,
Comment, ProcessingInstruction,
CDATA, and EntityRef. |
Element |
getCopy(String name)
Deprecated. Deprecated in beta7, use clone() and setName() instead |
Element |
getCopy(String name,
Namespace ns)
Deprecated. Deprecated in beta7, use clone(), setName(), and setNamespace() instead |
Document |
getDocument()
This retrieves the owning for
this Element, or null if not a currently a member of a
. |
List |
getMixedContent()
Deprecated. Deprecated in beta7, use getContent() instead |
String |
getName()
This returns the (local) name of the Element, without any
namespace prefix, if one exists. |
Namespace |
getNamespace()
This will return this Element's
. |
Namespace |
getNamespace(String prefix)
This returns the Namespace in scope on this element for the given prefix (this involves searching up the tree, so the results depend on the current location of the element). |
String |
getNamespacePrefix()
This returns the namespace prefix of the Element, if
one exists. |
String |
getNamespaceURI()
This returns the URI mapped to this Element's
prefix (or the default namespace if no prefix). |
Element |
getParent()
This will return the parent of this Element. |
String |
getQualifiedName()
This returns the full name of the Element, in the form
[namespacePrefix]:[localName]. |
String |
getSerializedForm()
Deprecated. Deprecated in beta7, use XMLOutputter.outputString(Element) instead |
String |
getText()
This returns the textual content directly held under this element. |
String |
getTextNormalize()
This returns the textual content of this element with all surrounding whitespace removed and internal whitespace normalized to a single space. |
String |
getTextTrim()
This returns the textual content of this element with all surrounding whitespace removed. |
boolean |
hasChildren()
|
int |
hashCode()
This returns the hash code for this Element. |
boolean |
hasMixedContent()
Deprecated. Deprecated in beta7 because hasMixedContent() is of little use and isn't really implemented as mixed content is defined |
boolean |
isRootElement()
This returns a boolean value indicating
whether this Element is a root
Element for a JDOM . |
boolean |
removeAttribute(String name)
This removes the attribute with the given name and within no namespace. |
boolean |
removeAttribute(String name,
Namespace ns)
This removes the attribute with the given name and within the given Namespace. |
boolean |
removeAttribute(String name,
String uri)
Deprecated. Deprecated in beta7, use removeAttribute(String, Namespace) instead. |
boolean |
removeChild(String name)
This removes the first child element (one level deep) with the given local name and belonging to no namespace. |
boolean |
removeChild(String name,
Namespace ns)
This removes the first child element (one level deep) with the given local name and belonging to the given namespace. |
boolean |
removeChildren()
This removes all child elements. |
boolean |
removeChildren(String name)
This removes all child elements (one level deep) with the given local name and belonging to no namespace. |
boolean |
removeChildren(String name,
Namespace ns)
This removes all child elements (one level deep) with the given local name and belonging to the given namespace. |
boolean |
removeContent(CDATA cdata)
This removes the specified CDATA. |
boolean |
removeContent(Comment comment)
This removes the specified Comment. |
boolean |
removeContent(Element element)
This removes the specified Element. |
boolean |
removeContent(EntityRef entity)
This removes the specified EntityRef. |
boolean |
removeContent(ProcessingInstruction pi)
This removes the specified ProcessingInstruction. |
void |
removeNamespaceDeclaration(Namespace additionalNamespace)
This will remove a namespace declarations from this element. |
Element |
setAttribute(Attribute attribute)
This sets an attribute value for this element. |
Element |
setAttribute(String name,
String value)
This sets an attribute value for this element. |
Element |
setAttribute(String name,
String value,
Namespace ns)
This sets an attribute value for this element. |
Element |
setAttributes(List attributes)
This sets all the attributes for this element to be those in the given List; all existing attributes are removed. |
Element |
setChildren(List children)
This sets the content of the element to be the List of Element objects within the supplied List. |
Element |
setContent(List newContent)
This sets the content of the element. |
protected Element |
setDocument(Document document)
This sets the parent of this element
and makes it the root element. |
Element |
setMixedContent(List mixedContent)
Deprecated. Deprecated in beta7, use setContent(List) instead |
Element |
setName(String name)
This sets the (local) name of the Element. |
Element |
setNamespace(Namespace namespace)
This sets this Element's . |
protected Element |
setParent(Element parent)
This will set the parent of this Element. |
Element |
setText(String text)
This sets the content of the element to be the text given. |
String |
toString()
This returns a String representation of the
Element, suitable for debugging. |
| Methods inherited from class java.lang.Object |
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
| Field Detail |
protected String name
Elementprotected transient Namespace namespace
Namespace of the Elementprotected transient List additionalNamespaces
Namespace declarations on this
elementprotected Object parent
protected List attributes
Elementprotected List content
Element| Constructor Detail |
protected Element()
This protected constructor is provided in order to support an Element subclass that wants full control over variable initialization. It intentionally leaves all instance variables null, allowing a lightweight subclass implementation. The subclass is responsible for ensuring all the get and set methods on Element behave as documented.
When implementing an Element subclass which doesn't
require full control over variable initialization, be aware that
simply calling super() (or letting the compiler add the implicit
super() call) will not initialize the instance variables which will
cause many of the methods to throw a
NullPointerException. Therefore, the
constructor for these subclasses should call one of the public
constructors so variable initialization is handled automatically.
public Element(String name,
Namespace namespace)
This will create a new Element
with the supplied (local) name, and define
the to be used.
If the provided namespace is null, the element will have
no namespace.
Namespace
name - String name of element.public Element(String name)
This will create an Element in no
.
Namespace
name - String name of element.
public Element(String name,
String uri)
This will create a new Element with
the supplied (local) name, and specifies the URI
of the the NamespaceElement
should be in, resulting it being unprefixed (in the default
namespace).
name - String name of element.uri - String URI for Namespace element
should be in.
public Element(String name,
String prefix,
String uri)
This will create a new Element with
the supplied (local) name, and specifies the prefix and URI
of the the NamespaceElement
should be in.
name - String name of element.uri - String URI for Namespace element
should be in.| Method Detail |
public String getName()
This returns the (local) name of the
Element, without any
namespace prefix, if one exists.
String - element name.public Element setName(String name)
This sets the (local) name of the Element.
Element - the element modified.public Namespace getNamespace()
This will return this Element's
.
Namespace
Namespace - Namespace object for this
Elementpublic Element setNamespace(Namespace namespace)
This sets this Element's .
If the provided namespace is null, the element will have no namespace.
Namespace
Element - the element modified.public String getNamespacePrefix()
This returns the namespace prefix
of the Element, if
one exists. Otherwise, an empty
String is returned.
String - namespace prefix.public String getNamespaceURI()
This returns the URI mapped to this Element's
prefix (or the default namespace if no prefix). If no
mapping is found, an empty String is returned.
String - namespace URI for this
Element.public Namespace getNamespace(String prefix)
This returns the Namespace in scope on this element for the given prefix (this involves searching up the tree, so the results depend on the current location of the element). It returns null if there is no Namespace in scope with the given prefix at this point in the document.
prefix - namespace prefix to look upNamespace - namespace in scope for the given
prefix on this Element, or null if none.public String getQualifiedName()
This returns the full name of the
Element, in the form
[namespacePrefix]:[localName]. If
no namespace prefix exists for the
Element, simply the
local name is returned.
String - full name of element.public void addNamespaceDeclaration(Namespace additionalNamespace)
This will add a namespace declarations to this element. This should not be used to add the declaration for this element itself; that should be assigned in the construction of the element. Instead, this is for adding namespace declarations on the element not relating directly to itself.
additionalNamespace - Namespace to add.public void removeNamespaceDeclaration(Namespace additionalNamespace)
This will remove a namespace declarations from this element. This should not be used to remove the declaration for this element itself; that should be handled in the construction of the element. Instead, this is for removing namespace declarations on the element not relating directly to itself. If the declaration is not present, this method does nothing.
additionalNamespace - Namespace to remove.public List getAdditionalNamespaces()
This will return any namespace declarations on this element
that exist, excluding the namespace of the element
itself, which can be obtained through
. If there are no additional
declarations, this returns an empty list. Note, the returned
list is not live, for performance reasons.
getNamespace()
List - the additional namespace declarations.public Element getParent()
This will return the parent of this Element.
If there is no parent, then this returns null.
Also note that on its own, this is not 100% sufficient to
see if the Element is not in use - this should
be used in tandem with
to determine this.
isRootElement()
Element.protected Element setParent(Element parent)
This will set the parent of this Element.
The caller is responsible for handling pre-existing parentage.
parent - Element to be new parent.Element - this Element modified.public Element detach()
This detaches the element from its parent, or does nothing if the element has no parent.
Element - this Element modified.public boolean isRootElement()
This returns a boolean value indicating
whether this Element is a root
Element for a JDOM .
This should be used in tandem with
Document to determine
if an getParent()Element has no "attachments" to
parents.
boolean - whether this is a root element.protected Element setDocument(Document document)
This sets the parent of this element
and makes it the root element. The caller is responsible for
ensuring the element doesn't have a pre-existing parent.
Document
document - Document parentDocument this Element modifiedpublic Document getDocument()
This retrieves the owning for
this Element, or null if not a currently a member of a
Document.
Document
Document owning this Element, or null.public String getText()
This returns the textual content directly held under this
element. This will include all text within
this single element, including whitespace and CDATA
sections if they exist. It's essentially the concatenation of
all String nodes returned by getContent(). The call does not
recurse into child elements. If no textual value exists for the
element, an empty String ("") is returned.
public String getTextTrim()
This returns the textual content of this element with all surrounding whitespace removed. If no textual value exists for the element, or if only whitespace exists, the empty string is returned.
public String getTextNormalize()
This returns the textual content of this element with all surrounding whitespace removed and internal whitespace normalized to a single space. If no textual value exists for the element, or if only whitespace exists, the empty string is returned.
public String getChildText(String name)
This convenience method returns the textual content of the named
child element, or returns an empty String ("")
if the child has no textual content. However, if the child does
not exist, null is returned.
name - the name of the childpublic String getChildTextTrim(String name)
This convenience method returns the trimmed textual content of the
named child element, or returns null if there's no such child.
See for details of text trimming.
getTextTrim()
name - the name of the child
public String getChildText(String name,
Namespace ns)
This convenience method returns the textual content of the named child element, or returns null if there's no such child.
name - the name of the childns - the namespace of the child
public String getChildTextTrim(String name,
Namespace ns)
This convenience method returns the trimmed textual content of the
named child element, or returns null if there's no such child.
See for
details of text trimming.
getTextTrim()
name - the name of the childns - the namespace of the childpublic Element setText(String text)
This sets the content of the element to be the text given.
All existing text content and non-text context is removed.
If this element should have both textual content and nested
elements, use instead.
Setting a null text value is equivalent to setting an empty string
value.
setContent(java.util.List)
text - new content for the elementpublic boolean hasMixedContent()
This will indicate whether the element has mixed content or not.
Mixed content is when an element contains both textual and
element data within it. When this evaluates to true,
should be used for getting
element data.
getMixedContent()
boolean - indicating whether there
is mixed content (both textual data and elements).public List getContent()
This returns the full content of the element as a List which
may contain objects of type String, Element,
Comment, ProcessingInstruction,
CDATA, and EntityRef.
The List returned is "live" in document order and modifications
to it affect the element's actual contents. Whitespace content is
returned in its entirety.
List containing the mixed content of the
element: may contain String,
Element, Comment,
ProcessingInstruction,
CDATA, and
EntityRef objects.public Element setContent(List newContent)
This sets the content of the element. The passed in List should
contain only objects of type String, Element,
Comment, ProcessingInstruction,
CDATA, and EntityRef. Passing a null or
empty List clears the existing content. In event of an exception
the original content will be unchanged and the items in the added
content will be unaltered.
public boolean hasChildren()
public List getChildren()
This returns a List of all the child elements
nested directly (one level deep) within this element, as
Element objects. If this target element has no nested
elements, an empty List is returned. The returned list is "live"
in document order and changes to it affect the element's actual
contents.
This performs no recursion, so elements nested two levels deep would have to be obtained with:
Iterator itr = currentElement.getChildren().iterator();
while (itr.hasNext()) {
Element oneLevelDeep = (Element)nestedElements.next();
List twoLevelsDeep = oneLevelDeep.getChildren();
// Do something with these children
}
Element objects for this elementpublic Element setChildren(List children)
This sets the content of the element to be the List of
Element objects within the supplied List.
All existing element and non-element content of the element is removed.
In event of an exception the children may be partially added.
children - List of Element objects to addpublic List getChildren(String name)
This returns a List of all the child elements
nested directly (one level deep) within this element with the given
local name and belonging to no namespace, returned as
Element objects. If this target element has no nested
elements with the given name outside a namespace, an empty List
is returned. The returned list is "live" in document order
and changes to it affect the element's actual contents.
Please see the notes for
for a code example.
getChildren()
name - local name for the children to match
public List getChildren(String name,
Namespace ns)
This returns a List of all the child elements
nested directly (one level deep) within this element with the given
local name and belonging to the given Namespace, returned as
Element objects. If this target element has no nested
elements with the given name in the given Namespace, an empty List
is returned. The returned list is "live" in document order
and changes to it affect the element's actual contents.
Please see the notes for
for a code example.
getChildren()
name - local name for the children to matchns - Namespace to search within
public Element getChild(String name,
Namespace ns)
This returns the first child element within this element with the given local name and belonging to the given namespace. If no elements exist for the specified name and namespace, null is returned.
name - local name of child element to matchns - Namespace to search withinpublic Element getChild(String name)
This returns the first child element within this element with the given local name and belonging to no namespace. If no elements exist for the specified name and namespace, null is returned.
name - local name of child element to matchpublic Element addContent(String text)
This adds text content to this element. It does not replace the
existing content as does setText().
text - String to addpublic Element addContent(Element element)
This adds element content to this element.
element - Element to addpublic Element addContent(ProcessingInstruction pi)
This adds a processing instruction as content to this element.
pi - ProcessingInstruction to addpi, already has a parent.public Element addContent(EntityRef entity)
This adds entity content to this element.
entity - EntityRef to addpublic Element addContent(CDATA cdata)
This adds a CDATA section as content to this element.
cdata - CDATA to addpublic Element addContent(Comment comment)
This adds a comment as content to this element.
comment - Comment to addpublic boolean removeChild(String name)
This removes the first child element (one level deep) with the given local name and belonging to no namespace. Returns true if a child was removed.
name - the name of child elements to remove
public boolean removeChild(String name,
Namespace ns)
This removes the first child element (one level deep) with the given local name and belonging to the given namespace. Returns true if a child was removed.
name - the name of child element to removens - Namespace to search withinpublic boolean removeChildren(String name)
This removes all child elements (one level deep) with the given local name and belonging to no namespace. Returns true if any were removed.
name - the name of child elements to remove
public boolean removeChildren(String name,
Namespace ns)
This removes all child elements (one level deep) with the given local name and belonging to the given namespace. Returns true if any were removed.
name - the name of child elements to removens - Namespace to search withinpublic boolean removeChildren()
This removes all child elements. Returns true if any were removed.
public List getAttributes()
This returns the complete set of attributes for this element, as a
List of Attribute objects in no particular
order, or an empty list if there are none.
The returned list is "live" and changes to it affect the
element's actual attributes.
public Attribute getAttribute(String name)
This returns the attribute for this element with the given name and within no namespace.
name - name of the attribute to return
public Attribute getAttribute(String name,
Namespace ns)
This returns the attribute for this element with the given name and within the given Namespace.
name - name of the attribute to returnns - Namespace to search withinpublic String getAttributeValue(String name)
This returns the attribute value for the attribute with the given name and within no namespace, null if there is no such attribute, and the empty string if the attribute value is empty.
name - name of the attribute whose value to be returned
public String getAttributeValue(String name,
Namespace ns)
This returns the attribute value for the attribute with the given name and within the given Namespace, null if there is no such attribute, and the empty string if the attribute value is empty.
name - name of the attribute whose valud is to be returnedns - Namespace to search withinpublic Element setAttributes(List attributes)
This sets all the attributes for this element to be those
in the given List; all existing attributes are removed.
attributes - List of attributes to set
public Element setAttribute(String name,
String value)
This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.
name - name of the attribute to setvalue - value of the attribute to set
public Element setAttribute(String name,
String value,
Namespace ns)
This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.
name - name of the attribute to setvalue - value of the attribute to setns - namespace of the attribute to setpublic Element setAttribute(Attribute attribute)
This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.
attribute - Attribute to set
public Element addAttribute(String name,
String value)
This adds an attribute to this element with the given name and value. To add attributes in namespaces using addAttribute(Attribute).
name - name of the attribute to addvalue - value of the attribute to add
public boolean removeAttribute(String name,
String uri)
This removes the attribute with the given name and within the given namespace URI.
name - name of attribute to removeuri - namespace URI of attribute to removepublic boolean removeAttribute(String name)
This removes the attribute with the given name and within no namespace. If no such attribute exists, this method does nothing.
name - name of attribute to remove
public boolean removeAttribute(String name,
Namespace ns)
This removes the attribute with the given name and within the given Namespace. If no such attribute exists, this method does nothing.
name - name of attribute to removens - namespace URI of attribute to removepublic String toString()
This returns a String representation of the
Element, suitable for debugging. If the XML
representation of the Element is desired,
XMLOutputter.outputString(Element)
should be used.
String - information about the
Elementpublic final boolean equals(Object ob)
This tests for equality of this Element to the supplied
Object, explicitly using the == operator.
ob - Object to compare topublic final int hashCode()
This returns the hash code for this Element.
public Object clone()
This returns a deep clone of this element. The new element is detached from its parent, and getParent() on the clone will return null.
public boolean removeContent(Element element)
This removes the specified Element.
If the specified Element is not a child of
this Element, this method does nothing.
child - Element to deletepublic boolean removeContent(ProcessingInstruction pi)
This removes the specified ProcessingInstruction.
If the specified ProcessingInstruction is not a child of
this Element, this method does nothing.
child - ProcessingInstruction to deletepublic boolean removeContent(Comment comment)
This removes the specified Comment.
If the specified Comment is not a child of
this Element, this method does nothing.
comment - Comment to deletepublic boolean removeContent(CDATA cdata)
This removes the specified CDATA.
If the specified CDATA is not a child of
this Element, this method does nothing.
cdata - CDATA to deletepublic boolean removeContent(EntityRef entity)
This removes the specified EntityRef.
If the specified EntityRef is not a child of
this Element, this method does nothing.
child - EntityRef to delete
public Element getCopy(String name,
Namespace ns)
This creates a copy of this Element, with the new
name specified, and in the specified .
Namespace
name - String name of new Element copy.ns - Namespace to put copy in.Element copy of this Element.public Element getCopy(String name)
This creates a copy of this Element, with the new
name specified, and in no namespace.
name - String name of new Element copy.public Element addAttribute(Attribute attribute)
This adds an attribute to this element. Any existing attribute with the same name and namespace URI is removed. (TODO: Code the replacement logic.)
attribute - Attribute to addpublic final String getSerializedForm()
This will return the Element in XML format,
usable in an XML document.
String - the serialized form of the
Element.public List getMixedContent()
This returns the full content of the element as a List which
may contain objects of type String, Element,
Comment, ProcessingInstruction,
CDATA, and EntityRef.
When there is technically no mixed content and
all contents are of the same type, then all objects returned in the
List will be of the same type. The List returned is "live" in
document order and modifications to it affect the element's actual
contents. Whitespace content is returned in its entirety.
List containing the mixed content of the
element: may contain String,
Element, Comment,
ProcessingInstruction,
CDATA, and
EntityRef objects.public Element setMixedContent(List mixedContent)
This sets the content of the element. The passed in List should
contain only objects of type String, Element,
Comment, ProcessingInstruction,
CDATA, and EntityRef. Passing a null or
empty List clears the existing content. In event of an exception
the original content will be unchanged and the items in the added
content will be unaltered.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||