From 61a2d23ef72630934c603fe9ffb96ebebff6ee09 Mon Sep 17 00:00:00 2001
From: netconomy <netconomy@7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c>
Date: Thu, 29 Nov 2007 12:00:22 +0000
Subject: PDF-AS API

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@233 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c
---
 .../java/at/gv/egiz/pdfas/api/io/DataSource.java   | 74 ++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 src/main/java/at/gv/egiz/pdfas/api/io/DataSource.java

(limited to 'src/main/java/at/gv/egiz/pdfas/api/io/DataSource.java')

diff --git a/src/main/java/at/gv/egiz/pdfas/api/io/DataSource.java b/src/main/java/at/gv/egiz/pdfas/api/io/DataSource.java
new file mode 100644
index 0000000..bd8e0db
--- /dev/null
+++ b/src/main/java/at/gv/egiz/pdfas/api/io/DataSource.java
@@ -0,0 +1,74 @@
+/**
+ * 
+ */
+package at.gv.egiz.pdfas.api.io;
+
+import java.io.InputStream;
+
+/**
+ * Input document data source.
+ * 
+ * <p>
+ * This allows the holder of the data to decide how the data is to be stored (e.g. in a File or in a byte array).
+ * </p>
+ * 
+ * @author wprinz
+ * 
+ */
+public interface DataSource
+{
+  /**
+   * Creates a new InputStream that allows to read out the document's binary
+   * data from the beginning.
+   * 
+   * @return Returns the InputStream with the binary data.
+   */
+  public InputStream createInputStream();
+
+  /**
+   * Returns the length (number of bytes) of the stream.
+   * 
+   * @return Returns the length (number of bytes) of the stream.
+   */
+  public int getLength();
+
+  /**
+   * Returns the data of this DataSource as a byte array for random read only access.
+   * 
+   * <p>
+   * Calling this method indicates that you need a byte array for random
+   * <strong>read only</strong> access. The DataSource implementation should of
+   * course cache this byte array to avoid too much memory usage.
+   * </p>
+   * <p>
+   * Performance analysis has shown that the libraries internally convert the
+   * streams to byte arrays and that file system access is very slow.
+   * </p>
+   * <p>
+   * Never write to this byte array!
+   * </p>
+   * 
+   * @return Returns the data of this DataSource as a byte array for random read only access.
+   */
+  public byte[] getAsByteArray();
+
+  /**
+   * Returns the mime type of the data.
+   * 
+   * @return Returns the mime type of the data.
+   */
+  public String getMimeType();
+
+  /**
+   * Returns the character encoding of the data.
+   * 
+   * <p>
+   * This makes only sense for character based mime types.
+   * </p>
+   * 
+   * @return Returns the character encoding of the data or null if no encoding
+   *         is applicable (e.g. if the data is binary).
+   */
+  public String getCharacterEncoding();
+
+}
-- 
cgit v1.2.3