org.fulib.tools.pipe

Class CodeFencePipe

java.lang.Object

org.fulib.tools.pipe.CodeFencePipe

All Implemented Interfaces:

Pipe

public class CodeFencePipe
extends java.lang.Object
implements Pipe

A pipe that puts the input text into a markdown code fence. E.g.,

    hello
    world
 

Is transformed to

    ```
    hello
    world
    ```
 

You can specify a language tag with the pipe argument (e.g. fenced:js). In this case, the output will be:

    ```js
    hello
    world
    ```
 

Using the CodeFencePipe(String) constructor, you can specify a default language tag that will be used when none is specified via the argument.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
CodeFencePipe()
CodeFencePipe(java.lang.String defaultLanguage)

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.lang.String content, java.lang.String arg) Transforms the input text of the code fragment to the output format specified by this pipe.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

CodeFencePipe

public CodeFencePipe()

CodeFencePipe

public CodeFencePipe(java.lang.String defaultLanguage)

Method Detail

apply

public java.lang.String apply(java.lang.String content,
                              java.lang.String arg)

Description copied from interface: Pipe

Transforms the input text of the code fragment to the output format specified by this pipe.

Specified by:

apply in interface Pipe

Parameters:

content - the input text

arg - the pipe argument of the form <pipeName> or <pipeName>:<args>

Returns:

the transformed text