- java.lang.Object
-
- javax.swing.text.ElementIterator
-
- All Implemented Interfaces:
- Cloneable
public class ElementIterator extends Object implements Cloneable
ElementIterator, as the name suggests, iteratates over the Element tree. The constructor can be invoked with either Document or an Element as an argument. If the constructor is invoked with a Document as an argument then the root of the iteration is the return value of document.getDefaultRootElement(). The iteration happens in a depth-first manner. In terms of how boundary conditions are handled: a) if next() is called before first() or current(), the root will be returned. b) next() returns null to indicate the end of the list. c) previous() returns null when the current element is the root or next() has returned null. The ElementIterator does no locking of the Element tree. This means that it does not track any changes. It is the responsibility of the user of this class, to ensure that no changes happen during element iteration. Simple usage example: public void iterate() { ElementIterator it = new ElementIterator(root); Element elem; while (true) { if ((elem = next()) != null) { // process element System.out.println("elem: " + elem.getName()); } else { break; } } }
-
-
Constructor Summary
Constructors Constructor and Description ElementIterator(Document document)
Creates a new ElementIterator.ElementIterator(Element root)
Creates a new ElementIterator.
-
Method Summary
Methods Modifier and Type Method and Description Object
clone()
Clones the ElementIterator.Element
current()
Fetches the current Element.int
depth()
Fetches the current depth of element tree.Element
first()
Fetches the first element.Element
next()
Fetches the next Element.Element
previous()
Fetches the previous Element.
-
-
-
Constructor Detail
-
ElementIterator
public ElementIterator(Document document)
Creates a new ElementIterator. The root element is taken to get the default root element of the document.- Parameters:
document
- a Document.
-
ElementIterator
public ElementIterator(Element root)
Creates a new ElementIterator.- Parameters:
root
- the root Element.
-
-
Method Detail
-
clone
public Object clone()
Clones the ElementIterator.
-
first
public Element first()
Fetches the first element.- Returns:
- an Element.
-
depth
public int depth()
Fetches the current depth of element tree.- Returns:
- the depth.
-
current
public Element current()
Fetches the current Element.- Returns:
- element on top of the stack or
null
if the root element isnull
-
next
public Element next()
Fetches the next Element. The strategy used to locate the next element is a depth-first search.- Returns:
- the next element or
null
at the end of the list.
-
previous
public Element previous()
Fetches the previous Element. If howver the current element is the last element, or the current element is null, then null is returned.- Returns:
- previous
Element
if available
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/swing/text/elementiterator.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.