Package com.vaadin.flow.component.upload.receivers

Class FileBuffer

java.lang.Object
com.vaadin.flow.component.upload.receivers.AbstractFileBuffer
com.vaadin.flow.component.upload.receivers.FileBuffer
All Implemented Interfaces:
Receiver, Serializable
@Deprecated(since="24.8", forRemoval=true) public class FileBuffer extends AbstractFileBuffer implements Receiver
Deprecated, for removal: This API element is subject to removal in a future version.
Use UploadHandler instead
Basic in file receiver implementation. File is stored by default to File created using File.createTempFile(String, String) with a null suffix.

For a custom file the constructor AbstractFileBuffer(FileFactory) should be used.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    FileBuffer()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a file buffer with a default file factory.
    FileBuffer(FileFactory factory)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a file buffer that uses a file factory to create a custom upload File.

  • Method Summary

    Modifier and Type
    Method
    Description
    FileData
    getFileData()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the file data object.
    FileDescriptor
    getFileDescriptor()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the output stream for file.
    String
    getFileName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the file name for this buffer.
    InputStream
    getInputStream()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the input stream for file.
    OutputStream
    receiveUpload(String fileName, String mimeType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Invoked when a new upload arrives.

    Methods inherited from class com.vaadin.flow.component.upload.receivers.AbstractFileBuffer

    createFileOutputStream, getLogger

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • FileBuffer

      public FileBuffer()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a file buffer with a default file factory.

      Files will be created using File.createTempFile(String, String) and have that build 'upload_tmpfile_{FILENAME}_{currentTimeMillis}'

    • FileBuffer

      public FileBuffer(FileFactory factory)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a file buffer that uses a file factory to create a custom upload File.
      Parameters:
      factory - file factory for file buffer

  • Method Details

    • receiveUpload

      public OutputStream receiveUpload(String fileName, String mimeType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Receiver
      Invoked when a new upload arrives.
      Specified by:
      receiveUpload in interface Receiver
      Parameters:
      fileName - the desired filename of the upload, usually as specified by the client
      mimeType - the MIME type of the uploaded file
      Returns:
      stream to which the uploaded file should be written

    • getFileData

      public FileData getFileData()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the file data object.
      Returns:
      file data for the latest upload or null

    • getFileName

      public String getFileName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the file name for this buffer.
      Returns:
      file name or empty if no file

    • getFileDescriptor

      public FileDescriptor getFileDescriptor()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the output stream for file.
      Returns:
      file output stream or null if not available

    • getInputStream

      public InputStream getInputStream()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the input stream for file.
      Returns:
      input stream for file or empty stream if file not found