public interface Parent
Superclass for JDOM objects which are allowed to contain Content
content.
Content
, Document
, Element
Method Summary | |
---|---|
java.lang.Object | clone() Obtain a deep, unattached copy of this parent and it's children. |
java.util.List | cloneContent() Returns a list containing detached clones of this parent's content list. |
java.util.List | getContent() Returns the full content of this parent as a List which contains objects of type Content . |
java.util.List | getContent(Filter filter) Returns as a List the content of this parent that matches the supplied filter. |
Content | getContent(int index) Returns the child at the given index. |
int | getContentSize() Returns the number of children in this parent's content list. |
java.util.Iterator | getDescendants() Returns an Iterator that walks over all descendants in document order. |
java.util.Iterator | getDescendants(Filter filter) Returns an Iterator that walks over all descendants in document order applying the Filter to return only elements that match the filter rule. |
Document | getDocument() Return this parent's owning document or null if the branch containing this parent is currently not attached to a document. |
Parent | getParent() Return this parent's parent, or null if this parent is currently not attached to another parent. |
int | indexOf(Content child) Returns the index of the supplied child in the content list, or -1 if not a child of this parent. |
java.util.List | removeContent() Removes all content from this parent and returns the detached children. |
boolean | removeContent(Content child) Removes a single child node from the content list. |
java.util.List | removeContent(Filter filter) Removes from this parent all child content matching the given filter and returns a list of the detached children. |
Content | removeContent(int index) Removes and returns the child at the given index, or returns null if there's no such child. |
Method Detail |
---|
int getContentSize()
Content
type. int indexOf(Content child)
child
- child to search for java.util.List cloneContent()
Content getContent(int index)
index
- location of desired child java.lang.IndexOutOfBoundsException
- if index is negative or beyond the current number of children java.lang.IllegalStateException
- if parent is a Document and the root element is not setjava.util.List getContent()
List
which contains objects of type Content
. The returned list is "live" and in document order. Any modifications to it affect the element's actual contents. Modifications are checked for conformance to XML 1.0 rules. Sequential traversal through the List is best done with an Iterator since the underlying implement of List.size()
may require walking the entire list and indexed lookups may require starting at the beginning each time.
java.lang.IllegalStateException
- if parent is a Document and the root element is not setjava.util.List getContent(Filter filter)
List
the content of this parent that matches the supplied filter. The returned list is "live" and in document order. Any modifications to it affect the element's actual contents. Modifications are checked for conformance to XML 1.0 rules. Sequential traversal through the List is best done with an Iterator since the underlying implement of List.size()
may require walking the entire list and indexed lookups may require starting at the beginning each time.
filter
- filter to apply java.lang.IllegalStateException
- if parent is a Document and the root element is not setjava.util.List removeContent()
java.util.List removeContent(Filter filter)
filter
- filter to apply boolean removeContent(Content child)
child
- child to remove Content removeContent(int index)
index
- index of child to remove java.lang.IndexOutOfBoundsException
- if index is negative or beyond the current number of childrenjava.lang.Object clone()
java.util.Iterator getDescendants()
Iterator
that walks over all descendants in document order. java.util.Iterator getDescendants(Filter filter)
Iterator
that walks over all descendants in document order applying the Filter to return only elements that match the filter rule. With filters you can match only Elements, only Comments, Elements or Comments, only Elements with a given name and/or prefix, and so on. filter
- filter to select which descendants to see Parent getParent()
Document getDocument()