aboutsummaryrefslogtreecommitdiff
path: root/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java
diff options
context:
space:
mode:
authorAndreas Fitzek <andreas.fitzek@iaik.tugraz.at>2014-02-05 09:21:35 +0100
committerAndreas Fitzek <andreas.fitzek@iaik.tugraz.at>2014-02-05 09:21:35 +0100
commit27fb69688a5de7e291ce5a2fd348becb1a722ad5 (patch)
treef7228da23b421bd3f50ced92485259090963119b /pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java
parent87c9269152f8c631123525b796cf07dc0cca7398 (diff)
downloadpdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.tar.gz
pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.tar.bz2
pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.zip
Javadoc for public API
Diffstat (limited to 'pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java')
-rw-r--r--pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java16
1 files changed, 16 insertions, 0 deletions
diff --git a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java
index 73487c7b..093a3777 100644
--- a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java
+++ b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/DataSource.java
@@ -1,6 +1,22 @@
package at.gv.egiz.pdfas.lib.api;
+/**
+ * Data Source interface
+ *
+ * All data sources in PDF-AS implement this interface. Also custom data sources have to
+ * implement this interface to allow PDF-AS to use them.
+ */
public interface DataSource {
+
+ /**
+ * Gets the MIME Type of the contained data.
+ * @return MIME Type
+ */
public String getMIMEType();
+
+ /**
+ * Gets the contained data
+ * @return the contained data
+ */
public byte[] getByteData();
}