Package com.github.rjeschke.txtmark

Class Configuration.Builder

  • Enclosing class:
    Configuration
    public static class Configuration.Builder
extends java.lang.Object
    Configuration builder.
    Since:
    0.7

    • Field Detail

      • safeMode

        private boolean safeMode

      • panicMode

        private boolean panicMode

      • forceExtendedProfile

        private boolean forceExtendedProfile

      • allowSpacesInFencedDelimiters

        private boolean allowSpacesInFencedDelimiters

      • encoding

        private java.lang.String encoding

      • specialLinkEmitter

        private SpanEmitter specialLinkEmitter

    • Constructor Detail

      • Builder

        Builder()
        Constructor.

    • Method Detail

      • enableSafeMode

        public Configuration.Builder enableSafeMode()
        Enables HTML safe mode. Default: false
        Returns:
        This builder
        Since:
        0.7

      • forceExtentedProfile

        public Configuration.Builder forceExtentedProfile()
        Forces extened profile to be enabled by default.
        Returns:
        This builder.
        Since:
        0.7

      • setSafeMode

        public Configuration.Builder setSafeMode​(boolean flag)
        Sets the HTML safe mode flag. Default: false
        Parameters:
        flag - true to enable safe mode
        Returns:
        This builder
        Since:
        0.7

      • setEncoding

        public Configuration.Builder setEncoding​(java.lang.String encoding)
        Sets the character encoding for txtmark. Default: "UTF-8"
        Parameters:
        encoding - The encoding
        Returns:
        This builder
        Since:
        0.7

      • setDecorator

        public Configuration.Builder setDecorator​(Decorator decorator)
        Sets the decorator for txtmark. Default: DefaultDecorator()
        Parameters:
        decorator - The decorator
        Returns:
        This builder
        Since:
        0.7
        See Also:
        DefaultDecorator

      • setCodeBlockEmitter

        public Configuration.Builder setCodeBlockEmitter​(BlockEmitter emitter)
        Sets the code block emitter. Default: null
        Parameters:
        emitter - The BlockEmitter
        Returns:
        This builder
        Since:
        0.7
        See Also:
        BlockEmitter

      • setSpecialLinkEmitter

        public Configuration.Builder setSpecialLinkEmitter​(SpanEmitter emitter)
        Sets the emitter for special link spans ([[ ... ]]).
        Parameters:
        emitter - The emitter.
        Returns:
        This builder.
        Since:
        0.7

      • setAllowSpacesInFencedCodeBlockDelimiters

        public Configuration.Builder setAllowSpacesInFencedCodeBlockDelimiters​(boolean allow)
        (Dis-)Allows spaces in fenced code block delimiter lines.
        Parameters:
        allow - whether to allow or not
        Returns:
        This builder.
        Since:
        0.12

      • setEnablePanicMode

        public Configuration.Builder setEnablePanicMode​(boolean panic)
        This allows you to enable 'panicMode'. When 'panicMode' is enabled, every < encountered will then be translated into &lt;
        Parameters:
        panic - whether to enable or not
        Returns:
        This builder.
        Since:
        0.12

      • enablePanicMode

        public Configuration.Builder enablePanicMode()
        This allows you to enable 'panicMode'. When 'panicMode' is enabled, every < encountered will then be translated into &lt;
        Returns:
        This builder.
        Since:
        0.12

      • build

        public Configuration build()
        Builds a configuration instance.
        Returns:
        a Configuration instance
        Since:
        0.7