Interface NodeFormatterFactory

All Superinterfaces:
Dependent
All Known Implementing Classes:
AbbreviationNodeFormatter.Factory, AdmonitionNodeFormatter.Factory, AsideNodeFormatter.Factory, AttributesNodeFormatter.Factory, CoreNodeFormatter.Factory, DefinitionNodeFormatter.Factory, EmojiNodeFormatter.Factory, EnumeratedReferenceNodeFormatter.Factory, FootnoteNodeFormatter.Factory, GitLabNodeFormatter.Factory, JekyllFrontMatterNodeFormatter.Factory, JekyllTagNodeFormatter.Factory, MacrosNodeFormatter.Factory, SimTocNodeFormatter.Factory, SpecExampleNodeFormatter.Factory, TableNodeFormatter.Factory, WikiLinkNodeFormatter.Factory, YamlFrontMatterNodeFormatter.Factory

public interface NodeFormatterFactory extends Dependent
Factory for instantiating new node renderers when rendering is done.
  • Method Details

    • create

      @NotNull @NotNull NodeFormatter create(@NotNull @NotNull DataHolder options)
      Create a new node renderer for the specified rendering context.
      Parameters:
      options - the context for rendering (normally passed on to the node renderer)
      Returns:
      a node renderer
    • getAfterDependents

      @Nullable default @Nullable Set<Class<?>> getAfterDependents()
      Specified by:
      getAfterDependents in interface Dependent
      Returns:
      null or a list of processors 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 pre processor is called.
    • getBeforeDependents

      @Nullable default @Nullable Set<Class<?>> getBeforeDependents()
      Specified by:
      getBeforeDependents in interface Dependent
      Returns:
      null or a list of processors before which this has to be run if any of the blocks in the list affect global state then these will be run on ALL blocks of the document before this pre processor is called.
    • affectsGlobalScope

      default 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.