lib/dev.hossain.timeline/Parser/parse

parse

suspend fun parse(file: File): TimelineData

Parses the given file into a TimelineData object using default configuration.

Return

The parsed TimelineData object.

Parameters

file

The JSON file of timeline data to be parsed.

Throws

if the file does not exist.

if the JSON format is invalid.

if there's an error reading the file.

suspend fun parse(file: File, config: ParserConfig): TimelineData

Parses the given file into a TimelineData object with custom configuration.

Return

The parsed TimelineData object.

Parameters

file

The JSON file of timeline data to be parsed.

config

Configuration options for parsing.

Throws

if the file does not exist.

if the JSON format is invalid.

if there's an error reading the file.

suspend fun parse(inputStream: InputStream): TimelineData

Parses the given input stream into a TimelineData object using default configuration.

Return

The parsed TimelineData object.

Parameters

inputStream

The input stream of JSON data to be parsed.

Throws

if the JSON format is invalid.

if there's an error reading the input stream.

suspend fun parse(inputStream: InputStream, config: ParserConfig): TimelineData

Parses the given input stream into a TimelineData object with custom configuration.

Return

The parsed TimelineData object.

Parameters

inputStream

The input stream of JSON data to be parsed.

config

Configuration options for parsing.

Throws

if the JSON format is invalid.

if there's an error reading the input stream.

suspend fun parse(bufferedSource: BufferedSource): TimelineData

Parses the given buffered source into a TimelineData object using default configuration.

Return

The parsed TimelineData object.

Parameters

bufferedSource

The buffered source of JSON data to be parsed.

Throws

if the JSON format is invalid.

if there's an error reading the buffered source.

suspend fun parse(bufferedSource: BufferedSource, config: ParserConfig): TimelineData

Parses the given buffered source into a TimelineData object with custom configuration.

Return

The parsed TimelineData object.

Parameters

bufferedSource

The buffered source of JSON data to be parsed.

config

Configuration options for parsing.

Throws

if the JSON format is invalid.

if there's an error reading the buffered source.