tecgraf.javautils.xml
Interface XMLListIteratorInterface

All Known Implementing Classes:

ImprovedXMLListIterator, XMLListIterator

public interface XMLListIteratorInterface

A interface XMLListIteratorInterface define as operações necessárias a iteradores de listas de elementos XML da forma como estes são retornados pelo parser.

Field Summary

static String

ANY Tag usada para iterar sobre qualquer elemento

Method Summary

String	getTag() Retorna a tag de referência para o iterador (o valor que será usado na comparação com os elementos da lista).
boolean	hasNext() Indica se existe mais algum elemento na lista cuja tag seja igual à solicitada.
XMLElementInterface	next() Retorna o próximo elemento com tipo igual ao que vínhamos buscando ou null caso não haja mais elementos deste tipo.
XMLElementInterface	next(String tag) Obtém o próximo elemento da lista que possui a tag desejada, ou null caso não haja mais elementos com esta tag. Se a tag solicitada é a mesma que vínhamos buscando, simplesmente continuamos a iteração.
void	reset() Reinicializa o iterador, usando a tag ANY como tag de busca.
void	reset(String tag) Reinicializa o iterador, redefinindo a tag de busca.

Field Detail

ANY

static final String ANY

Tag usada para iterar sobre qualquer elemento

See Also:

Constant Field Values

Method Detail

reset

void reset(String tag)

Reinicializa o iterador, redefinindo a tag de busca.

Parameters:

tag - nova tag de busca

reset

void reset()

Reinicializa o iterador, usando a tag ANY como tag de busca.

next

XMLElementInterface next()

Retorna o próximo elemento com tipo igual ao que vínhamos buscando ou null caso não haja mais elementos deste tipo.

Returns:

o proximo elemento.

next

XMLElementInterface next(String tag)

Obtém o próximo elemento da lista que possui a tag desejada, ou null caso não haja mais elementos com esta tag.
Se a tag solicitada é a mesma que vínhamos buscando, simplesmente continuamos a iteração. Neste caso, se não encontramos mais nenhum elemento retornamos null mas mantemos o iterador no próximo elemento diferente do solicitado, para que este possa ser reaproveitado em buscas subsequentes. Isto permite que o percorrimento seja retomado caso a busca por um determinado elemento já tenha sido esgotada.
Se porém a tag solicitada for diferente da que vínhamos buscando, o iterador buscará um elemento do tipo solicitado até encontrá-lo ou até ter percorrido toda a lista de elementos. Caso a lista tenha sido "esgotada", qualquer tentativa posterior de busca por um elemento resultará em null.

Parameters:

tag - nova tag de busca

Returns:

próximo elemento do tipo solicitado ou null caso este não exista. Mesmoq que o valor retornado seja null, ainda assim a lista pode ainda ter elementos a serem percorridos (ver observação acima)

hasNext

boolean hasNext()

Indica se existe mais algum elemento na lista cuja tag seja igual à solicitada.

Returns:

true se o elemento seguinte na lista possui tag igual à tag de busca, false caso contrário.

getTag

String getTag()

Retorna a tag de referência para o iterador (o valor que será usado na comparação com os elementos da lista).

Returns:

tag de referência para o iterador