kris-core/ch.difty.kris

Package-level declarations

KRis is the object at the core of the KRis library. If provides a number of accessor methods to Java Clients that offer to convert Strings to RisRecords or vice versa, in different flavors of data input, non-blocking usage kotlin flows or RxJava observables or in a blocking manner accepting lists.

KrisExtensions offers a number of handy extension functions to kotlin clients.

Types

KRis

object KRis

RIS format processor and builder. It is capable of

KRisException

class KRisException(message: String) : Throwable

Properties

risTagNames

val risTagNames: List<String>

List of the names of all RisTags.

Functions

toRisLines

@JvmOverloads

fun List<RisRecord>.toRisLines(sort: List<String> = emptyList()): List<String>

Converts a list of RisRecords into a list of Strings in RIS file format. Optionally accepts a list of names of RisTags defining a sort order for the RisTags in the file.

fun Sequence<RisRecord>.toRisLines(scope: CoroutineScope = GlobalScope): Sequence<String>

Processes a sequence of RisRecords into a sequence of Strings representing lines in RIS file format.

@JvmOverloads

fun Flow<RisRecord>.toRisLines(sort: List<String> = emptyList()): Flow<String>

Converts a flow of RisRecords into a flow of Strings in RIS file format. Optionally accepts a list of names of RisTags defining a sort order for the RisTags in the file.

toRisRecords

fun List<String>.toRisRecords(): List<RisRecord>

Converts a list of Strings (representing lines in a RIS file) (as receiver) itno a list of RisRecords. May throw a KRisException if the line list of Strings cannot be parsed successfully.

fun Flow<String>.toRisRecords(): Flow<RisRecord>

Converts a flow of Strings (representing lines in a RIS file) (as receiver) into a flow of RisRecords. May throw a KRisException if the line flow cannot be parsed successfully.

fun Sequence<String>.toRisRecords(scope: CoroutineScope = GlobalScope): Sequence<RisRecord>

Converts a sequence of Strings (representing lines in a RIS file) (as receiver) into a sequence of RisRecords in a blocking manner. May throw a KRisException if the line flow cannot be parsed successfully.