2 * Sone - Parser.java - Copyright © 2010–2020 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.text;
20 import java.io.Reader;
21 import javax.annotation.Nonnull;
22 import javax.annotation.Nullable;
25 * Interface for parsers that can create {@link Part}s from a text source
26 * (usually a {@link Reader}).
29 * The type of the parser context
31 public interface Parser<C extends ParserContext> {
34 * Create one or more {@link Part}s from the given text source.
39 * The parser context (may be {@code null})
40 * @return The parsed parts
43 Iterable<Part> parse(@Nonnull String source, @Nullable C context);