Interface FileResult

All Superinterfaces:
Result
All Known Implementing Classes:
ByteArrayFileResult, LazyInputStreamFileResult, LocalFileResult
public interface FileResult extends Result
A file result is a result type that has been produced by a Job and is processed by actions.
By convention, it always implies the flavor FILE.
Not all ResultAction can handle every FileResult; result flavors define the kind of information/data a FileResult represents, and actions will handle only results they support. A result can be processed by more than one ResultAction.
Since:
taskplanner 3.0

  • Method Details

    • getFlavors

      default List<ResultFlavor> getFlavors()
      Defines the types of data this result contains.
      Specified by:
      getFlavors in interface Result
      Returns:
      the ResultFlavor values of this result

    • getFileSize

      long getFileSize() throws Exception
      Returns the size of this result in bytes.
      Returns:
      the size in bytes
      Throws:
      Exception - if the result data makes problems
      Since:
      taskplanner 3.0

    • getFileContent

      @Nonnull InputStream getFileContent() throws Exception
      Get a stream to access the data of this result.

      Note that this method is called multiple times when more than one action processes this result. Those calls come one after another: the first action has finished its work (and closed the stream) before the second calls this method.

      The caller will close the Stream.

      Returns:
      an input stream that can transfer the data of this result
      Throws:
      Exception - if there is a problem accessing the data
      Since:
      taskplanner 3.0

    • getFileContentType

      @Nullable String getFileContentType() throws Exception
      Get the MIME type this result has.
      Returns:
      the content type of this result. When null, 'application/octet-stream' is to be used.
      Throws:
      Exception - if the type could not be determined due to an IO problem
      Since:
      taskplanner 3.0

    • getFileName

      @Nonnull String getFileName()
      Returns a human-readable name of this result, typically a file name.

      It depends on the Result-implementation and on the ResultAction whether and where this appears. For example, in an email, this can be used as the name of an attached file.

      Returns:
      a name for this result.
      Since:
      taskplanner 3.0