Class GfmUsersExtension

java.lang.Object

com.vladsch.flexmark.ext.gfm.users.GfmUsersExtension

All Implemented Interfaces:

HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class GfmUsersExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension

Extension for GitHub Users

Create it with create() and then configure it on the builders

The parsed GitHub user text is turned into GfmUser nodes.

Field Summary

Fields

Modifier and Type	Field	Description
static final DataKey<String>	GIT_HUB_USER_HTML_PREFIX
static final DataKey<String>	GIT_HUB_USER_HTML_SUFFIX
static final DataKey<String>	GIT_HUB_USER_URL_PREFIX
static final DataKey<String>	GIT_HUB_USER_URL_SUFFIX
static final DataKey<String>	GIT_HUB_USERS_URL_ROOT

Fields inherited from interface Extension

EMPTY_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
private	GfmUsersExtension()

Method Summary

Modifier and Type	Method	Description
static GfmUsersExtension	create()
void	extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)	Called to give each extension to register extension points that it contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	parserOptions(MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
void	rendererOptions(@NotNull MutableDataHolder options)	This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Methods inherited from class Object

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

Field Details

GIT_HUB_USERS_URL_ROOT

public static final DataKey<String> GIT_HUB_USERS_URL_ROOT

GIT_HUB_USER_URL_PREFIX

public static final DataKey<String> GIT_HUB_USER_URL_PREFIX

GIT_HUB_USER_URL_SUFFIX

public static final DataKey<String> GIT_HUB_USER_URL_SUFFIX

GIT_HUB_USER_HTML_PREFIX

public static final DataKey<String> GIT_HUB_USER_HTML_PREFIX

GIT_HUB_USER_HTML_SUFFIX

public static final DataKey<String> GIT_HUB_USER_HTML_SUFFIX

Constructor Details

GfmUsersExtension

private GfmUsersExtension()

Method Details

create

public static GfmUsersExtension create()

rendererOptions

public void rendererOptions(@NotNull
 @NotNull MutableDataHolder options)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

rendererOptions in interface HtmlRenderer.HtmlRendererExtension

Parameters:

options - option set that will be used for the builder

parserOptions

public void parserOptions(MutableDataHolder options)

Description copied from interface: Parser.ParserExtension

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Specified by:

parserOptions in interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

extend

public void extend(Parser.Builder parserBuilder)

Description copied from interface: Parser.ParserExtension

This method is called on all extensions so that they can register their custom processors

Specified by:

extend in interface Parser.ParserExtension

Parameters:

parserBuilder - parser builder with which to register extensions

See Also:

• Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
• Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
• Parser.Builder.customInlineParserFactory(InlineParserFactory)
• Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
• Parser.Builder.postProcessorFactory(PostProcessorFactory)
• Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
• Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
• Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
• Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)

extend

public void extend(@NotNull
 HtmlRenderer.Builder htmlRendererBuilder,
 @NotNull
 @NotNull String rendererType)

Description copied from interface: HtmlRenderer.HtmlRendererExtension

Called to give each extension to register extension points that it contains

Specified by:

extend in interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"

See Also:

• HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory)
• HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory)
• HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory)
• HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)