X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ftext%2FParser.java;h=06eed37458b63c0933f3296ccb799883bac7775e;hp=ccec36a74e37e6f73c6d1b7698b56cdc226a46a8;hb=438378deab1514f0f608d975ef65f5b7aea44ccb;hpb=e8411efc4eaff6418cad496eb34fd7bc260eb9cd diff --git a/src/main/java/net/pterodactylus/sone/text/Parser.java b/src/main/java/net/pterodactylus/sone/text/Parser.java index ccec36a..06eed37 100644 --- a/src/main/java/net/pterodactylus/sone/text/Parser.java +++ b/src/main/java/net/pterodactylus/sone/text/Parser.java @@ -1,5 +1,5 @@ /* - * Sone - Parser.java - Copyright © 2010 David Roden + * Sone - Parser.java - Copyright © 2010–2020 David Roden * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,26 +17,29 @@ package net.pterodactylus.sone.text; -import java.io.IOException; import java.io.Reader; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; /** * Interface for parsers that can create {@link Part}s from a text source * (usually a {@link Reader}). * - * @author David ‘Bombe’ Roden + * @param + * The type of the parser context */ -public interface Parser { +public interface Parser { /** - * Create a {@link Part} from the given text source. + * Create one or more {@link Part}s from the given text source. * * @param source * The text source - * @return The parsed part - * @throws IOException - * if an I/O error occurs + * @param context + * The parser context (may be {@code null}) + * @return The parsed parts */ - public Part parse(Reader source) throws IOException; + @Nonnull + Iterable parse(@Nonnull String source, @Nullable C context); }