Top Inners Constructors Methods
com.vladsch.flexmark.ext.gfm.tasklist.internal

public Class TaskListItemBlockPreProcessor

extends Object
implements BlockPreProcessor
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.parser.block.BlockPreProcessor
Imports
com.vladsch.flexmark.ast.BulletListItem, .ListItem, .OrderedListItem, com.vladsch.flexmark.ext.gfm.tasklist.TaskListItem, com.vladsch.flexmark.parser.block.BlockPreProcessor, .BlockPreProcessorFactory, .ParserState, com.vladsch.flexmark.util.ast.Block, com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.sequence.BasedSequence, org.jetbrains.annotations.NotNull, .Nullable, java.util.HashSet, .Set

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TaskListItemBlockPreProcessor.Factory

Constructor Summary

AccessConstructor and Description
public
TaskListItemBlockPreProcessor(DataHolder options)

Method Summary

Modifier and TypeMethod and Description
public void
preProcess(ParserState
parser state
state, Block
the block node to pre-process
block)

Implements com.vladsch.flexmark.parser.block.BlockPreProcessor.preProcess.

Called on block nodes of interest as given by the NodePreProcessorFactory after all blocks are closed but before inline processing is performed

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

TaskListItemBlockPreProcessorback to summary
public TaskListItemBlockPreProcessor(DataHolder options)

Method Detail

preProcessback to summary
public void preProcess(ParserState state, Block block)

Implements com.vladsch.flexmark.parser.block.BlockPreProcessor.preProcess.

Doc from com.vladsch.flexmark.parser.block.BlockPreProcessor.preProcess.

Called on block nodes of interest as given by the NodePreProcessorFactory after all blocks are closed but before inline processing is performed

Parameters
state:ParserState

parser state

block:Block

the block node to pre-process

Annotations
@Override
com.vladsch.flexmark.ext.gfm.tasklist.internal back to summary

public Class TaskListItemBlockPreProcessor.Factory

extends Object
implements BlockPreProcessorFactory
Class Inheritance
  • java.lang.Object
  • com.vladsch.flexmark.ext.gfm.tasklist.internal.TaskListItemBlockPreProcessor.Factory
All Implemented Interfaces
com.vladsch.flexmark.parser.block.BlockPreProcessorFactory, com.vladsch.flexmark.util.dependency.Dependent, java.util.function.Function

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public boolean
affectsGlobalScope()

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

public @NotNull BlockPreProcessor
apply(@NotNull ParserState
the function argument
state)

Implements 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 @NotNull Set<Class<? extends Block>>
getBlockTypes()

Implements com.vladsch.flexmark.parser.block.BlockPreProcessorFactory.getBlockTypes.

Block types that this pre-processors processes

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

affectsGlobalScopeback to summary
public 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 @NotNull BlockPreProcessor apply(@NotNull ParserState state)

Implements java.util.function.Function.apply.

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

Applies this function to the given argument.

Parameters
state:@NotNull ParserState

the function argument

Returns:@NotNull BlockPreProcessor

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
getBlockTypesback to summary
public @NotNull Set<Class<? extends Block>> getBlockTypes()

Implements com.vladsch.flexmark.parser.block.BlockPreProcessorFactory.getBlockTypes.

Doc from com.vladsch.flexmark.parser.block.BlockPreProcessorFactory.getBlockTypes.

Block types that this pre-processors processes

Returns:@NotNull Set<Class<? extends Block>>

set of block node types

Annotations
@NotNull
@Override