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/FileBased.java    | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 src/main/java/at/gv/egiz/pdfas/api/io/FileBased.java

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

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 ();
+
+}
-- 
cgit v1.2.3