Package com.helger.html.hc.impl

Class AbstractHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.impl.AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>

Type Parameters:

IMPLTYPE - Implementation type

CHILDTYPE - Child type

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>, IHCNode, Serializable

Direct Known Subclasses:

AbstractHCNodeList

@NotThreadSafe
public abstract class AbstractHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>
extends AbstractHCNode
implements IHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>

This class is an abstract HC node that represents a list of nodes without creating an HTML element by itself.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractHCHasChildrenMutable()

Method Summary

Modifier and Type	Method	Description
IMPLTYPE	addChild(CHILDTYPE aChild)	Add a new child.
IMPLTYPE	addChildAt(int nIndex, CHILDTYPE aChild)
protected void	afterAddChild(int nIndex, CHILDTYPE aChild)	Callback
protected void	afterRemoveChild(int nIndex, CHILDTYPE aChild)	Invoked after an element was removed.
protected void	beforeAddChild(CHILDTYPE aChild)	Callback
boolean	canConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)	This method checks whether the node is suitable for conversion to an IMicroNode.
protected com.helger.commons.collection.impl.ICommonsList<CHILDTYPE>	directGetAllChildren()
CHILDTYPE	findFirstChild(Predicate<? super IHCNode> aFilter)
<DSTTYPE> DSTTYPE	findFirstChildMapped(Predicate<? super IHCNode> aFilter, Function<? super IHCNode,? extends DSTTYPE> aMapper)
void	forAllChildren(Consumer<? super IHCNode> aConsumer)
void	forAllChildren(Predicate<? super IHCNode> aFilter, Consumer<? super IHCNode> aConsumer)
com.helger.commons.state.EContinue	forAllChildrenBreakable(Function<? super IHCNode,com.helger.commons.state.EContinue> aConsumer)
<DSTTYPE> void	forAllChildrenMapped(Predicate<? super IHCNode> aFilter, Function<? super IHCNode,? extends DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
com.helger.commons.collection.impl.ICommonsList<CHILDTYPE>	getAllChildren()
HCNodeList	getAllChildrenAsNodeList()
CHILDTYPE	getChildAtIndex(int nIndex)
int	getChildCount()
com.helger.commons.collection.impl.ICommonsIterable<CHILDTYPE>	getChildren()
protected com.helger.commons.collection.impl.ICommonsList<? extends CHILDTYPE>	getChildrenFormEmitting(com.helger.commons.collection.impl.ICommonsList<CHILDTYPE> aChildren)	Helper method that returns the elements in the correct order for emitting.
CHILDTYPE	getFirstChild()
CHILDTYPE	getLastChild()
String	getPlainText()
boolean	hasChildren()
protected com.helger.xml.microdom.IMicroContainer	internalConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)
IMPLTYPE	removeAllChildren()	Remove all children of this object.
IMPLTYPE	removeChild(CHILDTYPE aChild)	Remove the passed direct child object.
IMPLTYPE	removeChildAt(int nIndex)	Remove the child at the specified index.
IMPLTYPE	sortAllChildren(Comparator<? super CHILDTYPE> aComparator)	Sort all children with the passed comparator
String	toString()

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, internalSetNodeState, onConsistencyCheck, onCustomizeNode, onFinalizeNodeState, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.html.hc.IHCHasChildrenMutable

addAndReturnChild, addAndReturnChildAt, addChildren, addChildren, addChildren, addChildrenAt, addChildrenAt, setChild

Methods inherited from interface com.helger.html.hc.IHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, registerExternalResources

Constructor Detail

AbstractHCHasChildrenMutable

public AbstractHCHasChildrenMutable()

Method Detail

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

hasChildren in class AbstractHCNode

beforeAddChild

@OverrideOnDemand
protected void beforeAddChild(@Nonnull
                              CHILDTYPE aChild)

Callback

Parameters:

aChild - The child that was added

afterAddChild

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void afterAddChild(@Nonnegative
                             int nIndex,
                             @Nonnull
                             CHILDTYPE aChild)

Callback

Parameters:

nIndex - Index where the child was added. Always ≥ 0.

aChild - The child that was added

addChild

@Nonnull
public final IMPLTYPE addChild(@Nullable
                               CHILDTYPE aChild)

Description copied from interface: IHCHasChildrenMutable

Add a new child.

Specified by:

addChild in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Parameters:

aChild - Child to add. May be null in which case nothing happens.

Returns:

this

addChildAt

@Nonnull
public final IMPLTYPE addChildAt(@Nonnegative
                                 int nIndex,
                                 @Nullable
                                 CHILDTYPE aChild)

Specified by:

addChildAt in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Parameters:

nIndex - The index to where the element should be inserted.

aChild - Child to add. May be null in which case nothing happens.

Returns:

this

afterRemoveChild

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void afterRemoveChild(@Nonnegative
                                int nIndex,
                                @Nonnull
                                CHILDTYPE aChild)

Invoked after an element was removed.

Parameters:

nIndex - The index where the element was removed from. Always ≥ 0. This is the OLD index and now contains a different or no child.

aChild - The child that was removed. Never null.

removeChild

@Nonnull
public final IMPLTYPE removeChild(@Nullable
                                  CHILDTYPE aChild)

Description copied from interface: IHCHasChildrenMutable

Remove the passed direct child object.

Specified by:

removeChild in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Parameters:

aChild - The node to be removed. May be null in which case nothing happens.

Returns:

this for chaining

removeChildAt

@Nonnull
public final IMPLTYPE removeChildAt(@Nonnegative
                                    int nIndex)

Description copied from interface: IHCHasChildrenMutable

Remove the child at the specified index.

Specified by:

removeChildAt in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Parameters:

nIndex - The index to use. Must be ≥ 0.

Returns:

this for chaining

removeAllChildren

@Nonnull
public final IMPLTYPE removeAllChildren()

Description copied from interface: IHCHasChildrenMutable

Remove all children of this object.

Specified by:

removeAllChildren in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Returns:

this for chaining

getChildCount

@Nonnegative
public final int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

getChildCount in class AbstractHCNode

directGetAllChildren

@Nullable
@ReturnsMutableObject("speed")
protected final com.helger.commons.collection.impl.ICommonsList<CHILDTYPE> directGetAllChildren()

getAllChildren

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<CHILDTYPE> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

getAllChildren in class AbstractHCNode

getChildren

@Nullable
public final com.helger.commons.collection.impl.ICommonsIterable<CHILDTYPE> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

getChildren in class AbstractHCNode

forAllChildren

public final void forAllChildren(@Nonnull
                                 Consumer<? super IHCNode> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

forAllChildren in class AbstractHCNode

forAllChildrenBreakable

@Nonnull
public final com.helger.commons.state.EContinue forAllChildrenBreakable(@Nonnull
                                                                        Function<? super IHCNode,com.helger.commons.state.EContinue> aConsumer)

Specified by:

forAllChildrenBreakable in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

forAllChildrenBreakable in class AbstractHCNode

forAllChildren

public final void forAllChildren(@Nonnull
                                 Predicate<? super IHCNode> aFilter,
                                 @Nonnull
                                 Consumer<? super IHCNode> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

forAllChildren in class AbstractHCNode

forAllChildrenMapped

public <DSTTYPE> void forAllChildrenMapped(@Nonnull
                                           Predicate<? super IHCNode> aFilter,
                                           @Nonnull
                                           Function<? super IHCNode,? extends DSTTYPE> aMapper,
                                           @Nonnull
                                           Consumer<? super DSTTYPE> aConsumer)

Specified by:

forAllChildrenMapped in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

forAllChildrenMapped in class AbstractHCNode

getChildAtIndex

@Nullable
public final CHILDTYPE getChildAtIndex(@Nonnegative
                                       int nIndex)

Specified by:

getChildAtIndex in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

getChildAtIndex in class AbstractHCNode

getFirstChild

@Nullable
public final CHILDTYPE getFirstChild()

Specified by:

getFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

getFirstChild in class AbstractHCNode

findFirstChild

@Nullable
public final CHILDTYPE findFirstChild(@Nonnull
                                      Predicate<? super IHCNode> aFilter)

Specified by:

findFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

findFirstChild in class AbstractHCNode

findFirstChildMapped

@Nullable
public final <DSTTYPE> DSTTYPE findFirstChildMapped(@Nonnull
                                                    Predicate<? super IHCNode> aFilter,
                                                    @Nonnull
                                                    Function<? super IHCNode,? extends DSTTYPE> aMapper)

Specified by:

findFirstChildMapped in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

findFirstChildMapped in class AbstractHCNode

getLastChild

@Nullable
public final CHILDTYPE getLastChild()

Specified by:

getLastChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>>

Overrides:

getLastChild in class AbstractHCNode

sortAllChildren

@Nonnull
public final IMPLTYPE sortAllChildren(@Nonnull
                                      Comparator<? super CHILDTYPE> aComparator)

Description copied from interface: IHCHasChildrenMutable

Sort all children with the passed comparator

Specified by:

sortAllChildren in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Parameters:

aComparator - The comparator to be used. May not be null.

Returns:

this for chaining

getAllChildrenAsNodeList

@Nonnull
public final HCNodeList getAllChildrenAsNodeList()

Specified by:

getAllChildrenAsNodeList in interface IHCHasChildrenMutable<IMPLTYPE extends AbstractHCHasChildrenMutable<IMPLTYPE,CHILDTYPE>,CHILDTYPE extends IHCNode>

Returns:

A new node list with all contained children. Never null but maybe empty.

canConvertToMicroNode

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
public boolean canConvertToMicroNode(@Nonnull
                                     IHCConversionSettingsToNode aConversionSettings)

Description copied from interface: IHCNode

This method checks whether the node is suitable for conversion to an IMicroNode. If this node cannot be converted, no child node will be converted as well!

Specified by:

canConvertToMicroNode in interface IHCNode

Overrides:

canConvertToMicroNode in class AbstractHCNode

Parameters:

aConversionSettings - The conversion settings to be used

Returns:

true if the node can be converted to a node, false otherwise.

getChildrenFormEmitting

@Nonnull
@Nonempty
@OverrideOnDemand
protected com.helger.commons.collection.impl.ICommonsList<? extends CHILDTYPE> getChildrenFormEmitting(@Nonnull @Nonempty
                                                                                                       com.helger.commons.collection.impl.ICommonsList<CHILDTYPE> aChildren)

Helper method that returns the elements in the correct order for emitting. This can e.g. be used for sorting or ordering.

Parameters:

aChildren - The children to be emitted. Is a direct reference to the container where the children are stored. So handle with care!

Returns:

The non-null list with all child elements to be emitted.

internalConvertToMicroNode

@Nonnull
@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected com.helger.xml.microdom.IMicroContainer internalConvertToMicroNode(@Nonnull
                                                                             IHCConversionSettingsToNode aConversionSettings)

Specified by:

internalConvertToMicroNode in class AbstractHCNode

getPlainText

@Nonnull
public String getPlainText()

Specified by:

getPlainText in interface IHCNode

Overrides:

getPlainText in class AbstractHCNode

Returns:

The plain text representation of this text. May not be null.

toString

public String toString()

Overrides:

toString in class AbstractHCNode