From 835256964f3fa64587a0e05b859d012d125be308 Mon Sep 17 00:00:00 2001 From: Andreas Fitzek Date: Thu, 20 Feb 2014 10:54:04 +0100 Subject: Documentation update --- docs/full/at/gv/egiz/pdfas/api/io/DataSource.html | 317 ++++++++++++++++++++++ 1 file changed, 317 insertions(+) create mode 100644 docs/full/at/gv/egiz/pdfas/api/io/DataSource.html (limited to 'docs/full/at/gv/egiz/pdfas/api/io/DataSource.html') diff --git a/docs/full/at/gv/egiz/pdfas/api/io/DataSource.html b/docs/full/at/gv/egiz/pdfas/api/io/DataSource.html new file mode 100644 index 00000000..c9841978 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/api/io/DataSource.html @@ -0,0 +1,317 @@ + + + + + +DataSource + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
at.gv.egiz.pdfas.api.io
+

Interface DataSource

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    ByteArrayDataSource_OLD, FileDataSource
    +
    +
    +
    Deprecated.
    +
    +
    @Deprecated
+public interface DataSource
    +
    Input document data source. + +

    + 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). +

    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.io.InputStreamcreateInputStream() +
      Deprecated. 
      +
      Creates a new InputStream that allows to read out the document's binary + data from the beginning.
      +
      byte[]getAsByteArray() +
      Deprecated. 
      +
      Returns the data of this DataSource as a byte array for random read only access.
      +
      java.lang.StringgetCharacterEncoding() +
      Deprecated. 
      +
      Returns the character encoding of the data.
      +
      intgetLength() +
      Deprecated. 
      +
      Returns the length (number of bytes) of the stream.
      +
      java.lang.StringgetMimeType() +
      Deprecated. 
      +
      Returns the mime type of the data.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createInputStream

        +
        java.io.InputStream createInputStream()
        +
        Deprecated. 
        +
        Creates a new InputStream that allows to read out the document's binary + data from the beginning.
        +
        Returns:
        Returns the InputStream with the binary data.
        +
        • +
      + + + +
        +
      • +

        getLength

        +
        int getLength()
        +
        Deprecated. 
        +
        Returns the length (number of bytes) of the stream.
        +
        Returns:
        Returns the length (number of bytes) of the stream.
        +
        • +
      + + + +
        +
      • +

        getAsByteArray

        +
        byte[] getAsByteArray()
        +
        Deprecated. 
        +
        Returns the data of this DataSource as a byte array for random read only access. + +

        + Calling this method indicates that you need a byte array for random + read only access. The DataSource implementation should of + course cache this byte array to avoid too much memory usage. +

        +

        + Performance analysis has shown that the libraries internally convert the + streams to byte arrays and that file system access is very slow. +

        +

        + Never write to this byte array! +

        +
        Returns:
        Returns the data of this DataSource as a byte array for random read only access.
        +
        • +
      + + + +
        +
      • +

        getMimeType

        +
        java.lang.String getMimeType()
        +
        Deprecated. 
        +
        Returns the mime type of the data.
        +
        Returns:
        Returns the mime type of the data.
        +
        • +
      + + + +
        +
      • +

        getCharacterEncoding

        +
        java.lang.String getCharacterEncoding()
        +
        Deprecated. 
        +
        Returns the character encoding of the data. + +

        + This makes only sense for character based mime types. +

        +
        Returns:
        Returns the character encoding of the data or null if no encoding + is applicable (e.g. if the data is binary).
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + -- cgit v1.2.3