tze.string-notation.1.4.0.source-code.StringNotation.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of string-notation Show documentation

Convert between different string notations commonly found in programming

The newest version!

package de.joshuagleitze.stringnotation

/**
 * A convention for representing [Words][Word].
 */
interface StringNotation {
	/**
	 * Transforms an input string that is in `this` notation into a notation-agnostic [Word].
	 */
	fun parse(sourceString: String): Word

	/**
	 * Transforms a [Word] into a string that is formatted according to `this` notation.
	 */
	fun print(word: Word): String
}