Package com.helger.html.hc.impl

Class AbstractHCWrappingNode

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.impl.AbstractHCWrappingNode

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, IHCNode, IHCWrappingNode, Serializable

Direct Known Subclasses:

HCConditionalCommentNode, HCOutOfBandNode

@NotThreadSafe
public abstract class AbstractHCWrappingNode
extends AbstractHCNode
implements IHCWrappingNode

Abstract implementation of IHCWrappingNode.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractHCWrappingNode()

Method Summary

Modifier and Type	Method	Description
boolean	canConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)	This method checks whether the node is suitable for conversion to an IMicroNode.
void	forAllChildren(Consumer<? super IHCNode> aConsumer)
void	forAllChildren(Predicate<? super IHCNode> aFilter, Consumer<? super IHCNode> aConsumer)
<DSTTYPE> void	forAllChildrenMapped(Predicate<? super IHCNode> aFilter, Function<? super IHCNode,? extends DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
com.helger.commons.collection.impl.ICommonsList<? extends IHCNode>	getAllChildren()
IHCNode	getChildAtIndex(int nIndex)
int	getChildCount()
com.helger.commons.collection.impl.ICommonsIterable<? extends IHCNode>	getChildren()
IHCNode	getFirstChild()
IHCNode	getLastChild()
EHCNodeState	getNodeState()
String	getPlainText()
boolean	hasChildren()
protected com.helger.xml.microdom.IMicroNode	internalConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)
protected void	onConsistencyCheck(IHCConversionSettingsToNode aConversionSettings)
protected void	onCustomizeNode(IHCCustomizer aCustomizer, EHTMLVersion eHTMLVersion, IHCHasChildrenMutable<?,? super IHCNode> aTargetNode)
protected void	onFinalizeNodeState(IHCConversionSettingsToNode aConversionSettings, IHCHasChildrenMutable<?,? super IHCNode> aTargetNode)	Finalize the node by applying any internal state that was not yet converted to a HC element.
protected void	onRegisterExternalResources(IHCConversionSettingsToNode aConversionSettings, boolean bForceRegistration)

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

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildrenBreakable, internalSetNodeState, registerExternalResources, toString

Methods inherited from class java.lang.Object

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

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

forAllChildrenBreakable, hasNoChildren

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

forAllChildrenRecursive, forAllChildrenRecursive

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

findFirstChild, findFirstChildMapped

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

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, registerExternalResources

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

getWrappedNode

Constructor Detail

AbstractHCWrappingNode

public AbstractHCWrappingNode()

Method Detail

getNodeState

@Nonnull
public EHCNodeState getNodeState()

Specified by:

getNodeState in interface IHCNode

Overrides:

getNodeState in class AbstractHCNode

Returns:

The current node state and never null.

onCustomizeNode

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void onCustomizeNode(@Nonnull
                               IHCCustomizer aCustomizer,
                               @Nonnull
                               EHTMLVersion eHTMLVersion,
                               @Nonnull
                               IHCHasChildrenMutable<?,? super IHCNode> aTargetNode)

Overrides:

onCustomizeNode in class AbstractHCNode

onFinalizeNodeState

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void onFinalizeNodeState(@Nonnull
                                   IHCConversionSettingsToNode aConversionSettings,
                                   @Nonnull
                                   IHCHasChildrenMutable<?,? super IHCNode> aTargetNode)

Description copied from class: AbstractHCNode

Finalize the node by applying any internal state that was not yet converted to a HC element. This method is called at maximum once per IHCNode. It is safe to still add classes, style or children to this node in this method.

Overrides:

onFinalizeNodeState in class AbstractHCNode

Parameters:

aConversionSettings - HC conversion settings

aTargetNode - The target node where additional nodes should be added

onConsistencyCheck

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void onConsistencyCheck(@Nonnull
                                  IHCConversionSettingsToNode aConversionSettings)

Overrides:

onConsistencyCheck in class AbstractHCNode

Parameters:

aConversionSettings - HC conversion settings

onRegisterExternalResources

@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void onRegisterExternalResources(@Nonnull
                                           IHCConversionSettingsToNode aConversionSettings,
                                           boolean bForceRegistration)

Overrides:

onRegisterExternalResources in class AbstractHCNode

Parameters:

aConversionSettings - HC conversion settings

bForceRegistration - true if the registration is forced by the caller.

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.

internalConvertToMicroNode

@Nullable
@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected com.helger.xml.microdom.IMicroNode 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.

getAllChildren

@Nullable
public com.helger.commons.collection.impl.ICommonsList<? extends IHCNode> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getAllChildren in class AbstractHCNode

getChildren

@Nullable
public com.helger.commons.collection.impl.ICommonsIterable<? extends IHCNode> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

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<IHCNode>

Overrides:

forAllChildren 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<IHCNode>

Overrides:

forAllChildren in class AbstractHCNode

forAllChildrenMapped

public final <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<IHCNode>

Overrides:

forAllChildrenMapped in class AbstractHCNode

getChildAtIndex

@Nullable
public IHCNode getChildAtIndex(int nIndex)

Specified by:

getChildAtIndex in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getChildAtIndex in class AbstractHCNode

getFirstChild

@Nullable
public IHCNode getFirstChild()

Specified by:

getFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getFirstChild in class AbstractHCNode

getLastChild

@Nullable
public IHCNode getLastChild()

Specified by:

getLastChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>

Overrides:

getLastChild in class AbstractHCNode

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Overrides:

hasChildren in class AbstractHCNode

getChildCount

@Nonnegative
public int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<IHCNode>

Overrides:

getChildCount in class AbstractHCNode