Allow InputStream or Reader as Parser input about commonmark-java HOT 9 CLOSED

What would be the viability of passing in more focused type, e.g. Iterable<String> or a custom interface such as a LineSupplier?

(And yes, the viability of Iterable for this type of abstraction is debatable, too.)

from commonmark-java.

That would make the common case of parsing a file or other stream of characters harder, because the caller would have to adapt a BufferedReader to an Iterable<String>. Also, the contract of an Iterable is that it can be iterated multiple times, which is not the case for a stream.

After some more thinking, I think we should add an overloaded parse with a Reader argument. If it's already a BufferedReader (e.g. from Files.newBufferedReader), we use it as-is, otherwise we wrap it in one. Then read line by line. The caller is responsible for closing it.

I think a Reader is better suited than InputStream, as we don't want to know about the Charset, the caller is responsible for that (also matches spec).

from commonmark-java.

There may also be situations where Iterable<String> makes sense, but we can add that later if needed.

from commonmark-java.

Thanks for working on this, @sentyaev. It would have been nice if you commented here first though, maybe @armstnp would have liked to implement this.

from commonmark-java.

All's good. 👍

from commonmark-java.

Implemented with a new method parseReader on Parser, thanks @sentyaev

from commonmark-java.

Released in 0.2.0.

from commonmark-java.

Great! My first open source project commit.

from commonmark-java.

Oh, congratulations! Hopefully there will be many more :).

from commonmark-java.