summaryrefslogtreecommitdiffstats
path: root/src/com/vaadin/terminal/UploadStream.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/com/vaadin/terminal/UploadStream.java')
-rw-r--r--src/com/vaadin/terminal/UploadStream.java50
1 files changed, 50 insertions, 0 deletions
diff --git a/src/com/vaadin/terminal/UploadStream.java b/src/com/vaadin/terminal/UploadStream.java
new file mode 100644
index 0000000000..95351e071d
--- /dev/null
+++ b/src/com/vaadin/terminal/UploadStream.java
@@ -0,0 +1,50 @@
+/*
+@ITMillApache2LicenseForJavaFiles@
+ */
+
+package com.vaadin.terminal;
+
+import java.io.InputStream;
+import java.io.Serializable;
+
+/**
+ * Defines a variable type, that is used for passing uploaded files from
+ * terminal. Most often, file upload is implented using the
+ * {@link com.vaadin.ui.Upload Upload} component.
+ *
+ * @author IT Mill Ltd.
+ * @version
+ * @VERSION@
+ * @since 3.0
+ */
+public interface UploadStream extends Serializable {
+
+ /**
+ * Gets the name of the stream.
+ *
+ * @return the name of the stream.
+ */
+ public String getStreamName();
+
+ /**
+ * Gets the input stream.
+ *
+ * @return the Input stream.
+ */
+ public InputStream getStream();
+
+ /**
+ * Gets the input stream content type.
+ *
+ * @return the content type of the input stream.
+ */
+ public String getContentType();
+
+ /**
+ * Gets stream content name. Stream content name usually differs from the
+ * actual stream name. It is used to identify the content of the stream.
+ *
+ * @return the Name of the stream content.
+ */
+ public String getContentName();
+}