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 ();
+
+}