Add stub for text parser infrastructure.
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Fri, 26 Nov 2010 06:01:10 +0000 (07:01 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Fri, 26 Nov 2010 06:01:10 +0000 (07:01 +0100)
src/main/java/net/pterodactylus/sone/text/Parser.java [new file with mode: 0644]
src/main/java/net/pterodactylus/sone/text/Part.java [new file with mode: 0644]

diff --git a/src/main/java/net/pterodactylus/sone/text/Parser.java b/src/main/java/net/pterodactylus/sone/text/Parser.java
new file mode 100644 (file)
index 0000000..ccec36a
--- /dev/null
@@ -0,0 +1,42 @@
+/*
+ * Sone - Parser.java - Copyright © 2010 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.text;
+
+import java.io.IOException;
+import java.io.Reader;
+
+/**
+ * Interface for parsers that can create {@link Part}s from a text source
+ * (usually a {@link Reader}).
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Parser {
+
+       /**
+        * Create a {@link Part} from the given text source.
+        *
+        * @param source
+        *            The text source
+        * @return The parsed part
+        * @throws IOException
+        *             if an I/O error occurs
+        */
+       public Part parse(Reader source) throws IOException;
+
+}
diff --git a/src/main/java/net/pterodactylus/sone/text/Part.java b/src/main/java/net/pterodactylus/sone/text/Part.java
new file mode 100644 (file)
index 0000000..b9083b7
--- /dev/null
@@ -0,0 +1,32 @@
+/*
+ * Sone - Part.java - Copyright © 2010 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.text;
+
+import net.pterodactylus.util.io.Renderable;
+
+/**
+ * A part is a single piece of information that can be displayed as a single
+ * element.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Part extends Renderable {
+
+       /* all required methods are inherited from {@link Renderable}. */
+
+}