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=e43ed47566f490f2aa850f41d2bcfb0a919b5280;hb=438378deab1514f0f608d975ef65f5b7aea44ccb;hpb=f4ea1e1b3526175e255831c975d6eea813589f25 diff --git a/src/main/java/net/pterodactylus/sone/text/Parser.java b/src/main/java/net/pterodactylus/sone/text/Parser.java index e43ed47..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,8 +17,9 @@ 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 @@ -26,21 +27,19 @@ import java.io.Reader; * * @param * The type of the parser context - * @author David ‘Bombe’ Roden */ 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 context - * The parser context * @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(C context, Reader source) throws IOException; + @Nonnull + Iterable parse(@Nonnull String source, @Nullable C context); }