Package icyllis.modernui.markflow

Class Markflow.Builder

java.lang.Object

icyllis.modernui.markflow.Markflow.Builder

Enclosing class:

Markflow

public static final class Markflow.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Markflow.Builder	bufferType(TextView.BufferType bufferType)	Specify the buffer type when applying text to a TextView.
Markflow	build()	Build a Markflow instance.
Markflow.Builder	textSetter(TextSetter textSetter)	Specify a method to install a rendered Markdown to a TextView.
Markflow.Builder	usePlugin(MarkflowPlugin plugin)	Register a plugin.

Methods inherited from class java.lang.Object

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

Method Details

bufferType

@NonNull
public Markflow.Builder bufferType(@NonNull
 TextView.BufferType bufferType)

Specify the buffer type when applying text to a TextView. The default is TextView.BufferType.SPANNABLE.

Note that if you insist on TextView.BufferType.SPANNABLE and your rendered Markdown text contains too many spans, consider setting a factory that returns a SpannableStringBuilder via the TextView.setSpannableFactory(icyllis.modernui.text.Spannable.Factory) It uses interval tree and hash table internally, making it much more efficient than SpannableString (default factory) when processing long and complex text. Although the text is editable, the TextView is not editable (bufferType is SPANNABLE).

Returns:

this

textSetter

@NonNull
public Markflow.Builder textSetter(@Nullable
 TextSetter textSetter)

Specify a method to install a rendered Markdown to a TextView. By default, TextView.setText(CharSequence, TextView.BufferType) is called directly.

Returns:

this

usePlugin

@NonNull
public Markflow.Builder usePlugin(@NonNull
 MarkflowPlugin plugin)

Register a plugin.

It's better to create a new Plugin object if it is mutable, depending on the implementation.

Returns:

this

build

@NonNull
public Markflow build()

Build a Markflow instance. This builder can be reused and the state will be preserved.

Throws:

IllegalStateException - no plugins were added, or required plugins were not added, or there were circular dependencies.