diff options
| author | netconomy <netconomy@7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c> | 2007-11-29 12:00:22 +0000 |
|---|---|---|
| committer | netconomy <netconomy@7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c> | 2007-11-29 12:00:22 +0000 |
| commit | 61a2d23ef72630934c603fe9ffb96ebebff6ee09 (patch) | |
| tree | ce05c4470d3a7a2743b4956f512288d6d0d62187 /src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java | |
| parent | 00809217ec7c890a844f9a7c667c71b550ad92a6 (diff) | |
| download | pdf-as-3-61a2d23ef72630934c603fe9ffb96ebebff6ee09.tar.gz pdf-as-3-61a2d23ef72630934c603fe9ffb96ebebff6ee09.tar.bz2 pdf-as-3-61a2d23ef72630934c603fe9ffb96ebebff6ee09.zip | |
PDF-AS API
git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@233 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c
Diffstat (limited to 'src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java')
| -rw-r--r-- | src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java b/src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java new file mode 100644 index 0000000..555b630 --- /dev/null +++ b/src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java @@ -0,0 +1,31 @@ +/**
+ *
+ */
+package at.gv.egiz.pdfas.api.io;
+
+import java.io.File;
+
+/**
+ * Tells that the IO element (DataSink or DataSource) is backed by a file in the local file system.
+ *
+ * <p>
+ * This is a hint that may be used by PDF-AS to optimize data access.
+ * </p>
+ *
+ * @author wprinz
+ */
+public interface FileBased
+{
+
+ /**
+ * Returns the File "behind" this io element.
+ *
+ * <p>
+ * This is usually used to determine the file name itself.
+ * </p>
+ *
+ * @return Returns the File "behind" this io element.
+ */
+ public File getFile ();
+
+}
|