• Home
• pl.wrzasq.commons
• commons-text
• 2.0.8
• source code
• FormatterInterface.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

pl.wrzasq.commons.text.formatter.FormatterInterface.kt Maven / Gradle / Ivy

/*
 * This file is part of the pl.wrzasq.commons.
 *
 * @license http://mit-license.org/ The MIT license
 * @copyright 2016, 2019, 2021 © by Rafał Wrzeszcz - Wrzasq.pl.
 */

package pl.wrzasq.commons.text.formatter

import pl.wrzasq.commons.text.TextProcessingException

/**
 * Source format handler interface.
 */
fun interface FormatterInterface {
    /**
     * Transforms source text into (X)HTML.
     *
     * @param text Source text.
     * @return (X)HTML snippet.
     * @throws TextProcessingException When text processing fails.
     */
    fun transform(text: String): String
}