com.helger.commons.microdom.util

Class ChildrenProviderElementWithName

java.lang.Object

com.helger.commons.microdom.util.ChildrenProviderElementWithName

All Implemented Interfaces:

IChildrenProvider<IMicroElement>

public final class ChildrenProviderElementWithName
extends Object
implements IChildrenProvider<IMicroElement>

Implementation of the IChildrenProvider for IMicroElement objects considering only elements with a certain element name (and optionally a namespace URI).

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ChildrenProviderElementWithName(String sTagName)
ChildrenProviderElementWithName(String sNamespaceURI, String sTagName)

Method Summary

Modifier and Type	Method and Description
Collection<? extends IMicroElement>	getAllChildren(IMicroElement aCurrent) Get the children of the passed object.
int	getChildCount(IMicroElement aCurrent)
boolean	hasChildren(IMicroElement aCurrent) Check if an item has children.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildrenProviderElementWithName

public ChildrenProviderElementWithName(@Nonnull @Nonempty
                                       String sTagName)

ChildrenProviderElementWithName

public ChildrenProviderElementWithName(@Nullable
                                       String sNamespaceURI,
                                       @Nonnull @Nonempty
                                       String sTagName)

Method Detail

hasChildren

public boolean hasChildren(@Nullable
                           IMicroElement aCurrent)

Description copied from interface: IChildrenProvider

Check if an item has children.

Specified by:

hasChildren in interface IChildrenProvider<IMicroElement>

Parameters:

aCurrent - The object to determine the children of. No null or non- null constraint possible.

Returns:

true if this item has children, false otherwise.

getChildCount

@Nonnegative
public int getChildCount(@Nullable
                                       IMicroElement aCurrent)

Specified by:

getChildCount in interface IChildrenProvider<IMicroElement>

Parameters:

aCurrent - The object to determine the children count of. No null or non- null constraint possible.

Returns:

The number of contained direct children. Always ≥ 0.

getAllChildren

@Nonnull
 @ReturnsMutableCopy
public Collection<? extends IMicroElement> getAllChildren(@Nullable
                                                                                          IMicroElement aCurrent)

Description copied from interface: IChildrenProvider

Get the children of the passed object.

Specified by:

getAllChildren in interface IChildrenProvider<IMicroElement>

Parameters:

aCurrent - The object to determine the children of. No null or non-null constraint possible.

Returns:

The child objects, or null if there are no children. If null is passed, the resolver is expected to return any possible top level (root) elements. This method may NOT return null if the call to IChildrenProvider.hasChildren(Object) with the same object returned true.