net.shibboleth.metadata.dom

Class AbstractElementVisitingStage

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.metadata.pipeline.BaseStage<Element>

net.shibboleth.metadata.dom.AbstractDOMTraversalStage

net.shibboleth.metadata.dom.AbstractElementVisitingStage

All Implemented Interfaces:

Stage<Element>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent

Direct Known Subclasses:

ElementWhitespaceTrimmingStage

public abstract class AbstractElementVisitingStage
extends AbstractDOMTraversalStage

Abstract parent class for stages which visit Elements named by a collection of QNames.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.metadata.dom.AbstractDOMTraversalStage

AbstractDOMTraversalStage.TraversalContext

Field Summary

Fields

Modifier and Type	Field and Description
private Set<QName>	elementNames Collection of element names for those elements we will be visiting.

Constructor Summary

Constructors

Constructor and Description
AbstractElementVisitingStage()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	applicable(Element e) Indicates whether the visitor should be applied to a particular Element.
protected void	doDestroy()
Collection<QName>	getElementNames() Gets the collection of element names to visit.
void	setElementName(QName name) Sets a single element name to be visited.
void	setElementNames(Collection<QName> names) Sets the collection of element names to visit.

Methods inherited from class net.shibboleth.metadata.dom.AbstractDOMTraversalStage

addError, ancestorEntity, doExecute, visit

Methods inherited from class net.shibboleth.metadata.pipeline.BaseStage

execute, getCollectionPredicate, setCollectionPredicate

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

elementNames

@Nonnull
private Set<QName> elementNames

Collection of element names for those elements we will be visiting.

Constructor Detail

AbstractElementVisitingStage

public AbstractElementVisitingStage()

Method Detail

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

getElementNames

@Nonnull
public Collection<QName> getElementNames()

Gets the collection of element names to visit.

Returns:

collection of element names to visit.

setElementNames

public void setElementNames(@Nonnull
                   Collection<QName> names)

Sets the collection of element names to visit.

Parameters:

names - collection of element names to visit.

setElementName

public void setElementName(@Nonnull
                  QName name)

Sets a single element name to be visited. Shorthand for setElementNames(java.util.Collection<javax.xml.namespace.QName>) with a singleton set.

Parameters:

name - QName for the element to be visited.

applicable

protected boolean applicable(@Nonnull
                 Element e)

Description copied from class: AbstractDOMTraversalStage

Indicates whether the visitor should be applied to a particular Element.

Specified by:

applicable in class AbstractDOMTraversalStage

Parameters:

e - Element to which we may wish to apply the visitor

Returns:

true if the visitor should be applied to this Element.