Class NodePostProcessorFactory

java.lang.Object

com.vladsch.flexmark.parser.block.NodePostProcessorFactory

All Implemented Interfaces:

PostProcessorFactory, Dependent, Function<Document, PostProcessor>

Direct Known Subclasses:

AbbreviationNodePostProcessor.Factory, AnchorLinkNodePostProcessor.Factory, AttributesNodePostProcessor.Factory, AutolinkNodePostProcessor.Factory, EnumeratedReferenceNodePostProcessor.Factory, EscapedCharacterNodePostProcessor.Factory, IncludeNodePostProcessor.Factory, MediaTagsNodePostProcessor.Factory, YouTubeLinkNodePostProcessor.Factory, ZzzzzzNodePostProcessor.Factory

public abstract class NodePostProcessorFactory
extends Object
implements PostProcessorFactory

Field Summary

Fields

Modifier and Type	Field	Description
private final HashMap<Class<?>, Set<Class<?>>>	NODE_MAP

Constructor Summary

Constructors

Constructor	Description
NodePostProcessorFactory(boolean ignored)

Method Summary

Modifier and Type	Method	Description
protected final void	addNodes(Class<?>... nodeTypes)
protected final void	addNodeWithExclusions(Class<? extends Node> nodeType, Class<?>... excludeDescendantsOf)
final boolean	affectsGlobalScope()
abstract @NotNull NodePostProcessor	apply(@NotNull Document document)
@Nullable Set<Class<?>>	getAfterDependents()
@Nullable Set<Class<?>>	getBeforeDependents()
final Map<Class<?>, Set<Class<?>>>	getNodeTypes()	A map of nodes of interest as keys and values a set of classes, if implemented by an ancestors then the node should be excluded from processing by this processor i.e.

Methods inherited from class Object

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

Methods inherited from interface Function

andThen, compose

Field Details

NODE_MAP

private final HashMap<Class<?>, Set<Class<?>>> NODE_MAP

Constructor Details

NodePostProcessorFactory

public NodePostProcessorFactory(boolean ignored)

Method Details

getAfterDependents

@Nullable
public @Nullable Set<Class<?>> getAfterDependents()

Specified by:

getAfterDependents in interface Dependent

Returns:

null or a list of dependents that must be executed before calling this one if any of the blocks in the list affect global state then these will be run on ALL blocks of the document before this preprocessor is called.

getBeforeDependents

@Nullable
public @Nullable Set<Class<?>> getBeforeDependents()

Specified by:

getBeforeDependents in interface Dependent

Returns:

null or a list of dependents that must be executed after calling this one if any of the blocks in the list affect global state then these will be run on ALL blocks of the document before this preprocessor is called.

affectsGlobalScope

public final boolean affectsGlobalScope()

Specified by:

affectsGlobalScope in interface Dependent

Returns:

true if this dependent affects the global scope, which means that any that depend on it have to be run after this dependent has run against all elements. Otherwise, the dependent can run on an element after its dependents have processed an element. parsed.

addNodeWithExclusions

protected final void addNodeWithExclusions(Class<? extends Node> nodeType,
 Class<?>... excludeDescendantsOf)

addNodes

protected final void addNodes(Class<?>... nodeTypes)

getNodeTypes

public final Map<Class<?>, Set<Class<?>>> getNodeTypes()

Description copied from interface: PostProcessorFactory

A map of nodes of interest as keys and values a set of classes, if implemented by an ancestors then the node should be excluded from processing by this processor i.e. DoNotDecorate.class if the processor adds links so that existing links will be ignored.

Specified by:

getNodeTypes in interface PostProcessorFactory

Returns:

a map of desired node types mapped to a set of ancestors under which the post processor does not process the block

apply

@NotNull
public abstract @NotNull NodePostProcessor apply(@NotNull
 @NotNull Document document)

Specified by:

apply in interface Function<Document, PostProcessor>

Specified by:

apply in interface PostProcessorFactory

Parameters:

document - for which to create the post processor

Returns:

post processor for the document