Top Fields Constructors Methods
com.vladsch.flexmark.parser.block

public abstract Class NodePostProcessorFactory

extends Object
implements PostProcessorFactory
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.parser.PostProcessorFactory, com.vladsch.flexmark.util.dependency.Dependent, java.util.function.Function
Imports
com.vladsch.flexmark.parser.PostProcessorFactory, com.vladsch.flexmark.util.ast.Document, .Node, org.jetbrains.annotations.NotNull, .Nullable, java.util.*

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
NodePostProcessorFactory(boolean ignored)

Method Summary

Modifier and TypeMethod and Description
protected final void
addNodes(Class<?>... nodeTypes)

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

public final boolean
affectsGlobalScope()

Implements com.vladsch.flexmark.util.dependency.Dependent.affectsGlobalScope.

public abstract @NotNull NodePostProcessor
apply(@NotNull Document
the function argument
document)

Redeclares java.util.function.Function.apply.

Applies this function to the given argument.

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

Implements com.vladsch.flexmark.util.dependency.Dependent.getAfterDependents.

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

Implements com.vladsch.flexmark.util.dependency.Dependent.getBeforeDependents.

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

Implements com.vladsch.flexmark.parser.PostProcessorFactory.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. DoNotDecorate.class if the processor adds links so that existing links will be ignored.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

NODE_MAPback to summary
private final HashMap<Class<?>, Set<Class<?>>> NODE_MAP

Constructor Detail

NodePostProcessorFactoryback to summary
public NodePostProcessorFactory(boolean ignored)

Method Detail

addNodesback to summary
protected final void addNodes(Class<?>... nodeTypes)
addNodeWithExclusionsback to summary
protected final void addNodeWithExclusions(Class<? extends Node> nodeType, Class<?>... excludeDescendantsOf)
affectsGlobalScopeback to summary
public final boolean affectsGlobalScope()

Implements com.vladsch.flexmark.util.dependency.Dependent.affectsGlobalScope.

Returns:boolean

Doc from com.vladsch.flexmark.util.dependency.Dependent.affectsGlobalScope.

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.

Annotations
@Override
applyback to summary
public abstract @NotNull NodePostProcessor apply(@NotNull Document document)

Redeclares java.util.function.Function.apply.

Doc from java.util.function.Function.apply.

Applies this function to the given argument.

Parameters
document:@NotNull Document

the function argument

Returns:@NotNull NodePostProcessor

the function result

Annotations
@NotNull
@Override
getAfterDependentsback to summary
public @Nullable Set<Class<?>> getAfterDependents()

Implements com.vladsch.flexmark.util.dependency.Dependent.getAfterDependents.

Returns:@Nullable Set<Class<?>>

Doc from com.vladsch.flexmark.util.dependency.Dependent.getAfterDependents.

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.

Annotations
@Nullable
@Override
getBeforeDependentsback to summary
public @Nullable Set<Class<?>> getBeforeDependents()

Implements com.vladsch.flexmark.util.dependency.Dependent.getBeforeDependents.

Returns:@Nullable Set<Class<?>>

Doc from com.vladsch.flexmark.util.dependency.Dependent.getBeforeDependents.

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.

Annotations
@Nullable
@Override
getNodeTypesback to summary
public final Map<Class<?>, Set<Class<?>>> getNodeTypes()

Implements com.vladsch.flexmark.parser.PostProcessorFactory.getNodeTypes.

Doc from com.vladsch.flexmark.parser.PostProcessorFactory.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. DoNotDecorate.class if the processor adds links so that existing links will be ignored.

Returns:Map<Class<?>, Set<Class<?>>>

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

Annotations
@Override