mfm.kt/com.github.samunohito.mfm.api.parser.core

Package-level declarations

Types

class AlternateParser(parsers: Collection<IMfmParser>) : IMfmParser

An implementation of IMfmParser that searches for a given string in a given string. The input string is expected to satisfy any IMfmParser passed to parsers. If all parsers fail, this implementation treats the search as failing as well.

FoundType

enum FoundType : Enum<FoundType>

Indicates the type of format found by IMfmParser

RegexParser

class RegexParser(regex: Regex) : IMfmParser

An implementation of IMfmParser that searches for a regular expression in a given string.

SequentialParser

class SequentialParser(parsers: Collection<IMfmParser>) : IMfmParser

An implementation of IMfmParser that sequentially searches for substrings using multiple other MFM parsers. We expect the input string to satisfy all IMfmParser passed to parsers, and if any one of the parsers fails, this implementation will also treat the search as failed.

StringParser

class StringParser(word: String) : IMfmParser

An implementation of IMfmParser that searches for a given string in a given string.