Return optionals of fields.
[Sone.git] / src / main / java / net / pterodactylus / sone / text / Parser.java
1 /*
2  * Sone - Parser.java - Copyright © 2010–2013 David Roden
3  *
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.
8  *
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.
13  *
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/>.
16  */
17
18 package net.pterodactylus.sone.text;
19
20 import java.io.IOException;
21 import java.io.Reader;
22
23 /**
24  * Interface for parsers that can create {@link Part}s from a text source
25  * (usually a {@link Reader}).
26  *
27  * @param <C>
28  *            The type of the parser context
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public interface Parser<C extends ParserContext> {
32
33         /**
34          * Create one or more {@link Part}s from the given text source.
35          *
36          * @param context
37          *            The parser context (may be {@code null})
38          * @param source
39          *            The text source
40          * @return The parsed parts
41          * @throws IOException
42          *             if an I/O error occurs
43          */
44         public Iterable<Part> parse(C context, Reader source) throws IOException;
45
46 }