Module io.jooby

Package io.jooby

Class FileDownload

java.lang.Object

io.jooby.FileDownload

Direct Known Subclasses:

AttachedFile, InlineFile

public class FileDownload
extends Object

Represents a file download.

Since:

2.9.0

Author:

edgar, imeszaros

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FileDownload.Builder	Allows creating a FileDownload with the specified FileDownload.Mode.
static enum	FileDownload.Mode	Download mode.

Constructor Summary

Constructors

Constructor	Description
FileDownload(FileDownload.Mode mode, byte[] content, String fileName)	Creates a new file attachment.
FileDownload(FileDownload.Mode mode, InputStream content, String fileName)	Creates a new file attachment.
FileDownload(FileDownload.Mode mode, InputStream content, String fileName, long fileSize)	Creates a new file attachment.
FileDownload(FileDownload.Mode mode, Path file)	Creates a new file attachment.
FileDownload(FileDownload.Mode mode, Path file, String fileName)	Creates a new file attachment.

Method Summary

Modifier and Type	Method	Description
static FileDownload.Builder	build(byte[] content, String fileName)	Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.
static FileDownload.Builder	build(InputStream content, String fileName)	Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.
static FileDownload.Builder	build(InputStream content, String fileName, long fileSize)	Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.
static FileDownload.Builder	build(Path file)	Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.
static FileDownload.Builder	build(Path file, String fileName)	Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.
String	getContentDisposition()	Content disposition header.
MediaType	getContentType()	File content type.
String	getFileName()	File name.
long	getFileSize()	File size or -1 if unknown.
InputStream	stream()	File content.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FileDownload

public FileDownload(FileDownload.Mode mode,
 @NonNull
 InputStream content,
 @NonNull
 String fileName,
 long fileSize)

Creates a new file attachment.

Parameters:

mode - Download mode.

content - File content.

fileName - Filename.

fileSize - File size or -1 if unknown.

FileDownload

public FileDownload(FileDownload.Mode mode,
 @NonNull
 InputStream content,
 @NonNull
 String fileName)

Creates a new file attachment.

Parameters:

mode - Download mode.

content - File content.

fileName - Filename.

FileDownload

public FileDownload(FileDownload.Mode mode,
 @NonNull
 byte[] content,
 @NonNull
 String fileName)

Creates a new file attachment.

Parameters:

mode - Download mode.

content - File content.

fileName - Filename.

FileDownload

public FileDownload(FileDownload.Mode mode,
 @NonNull
 Path file,
 @NonNull
 String fileName)
             throws IOException

Creates a new file attachment.

Parameters:

mode - Download mode.

file - File content.

fileName - Filename.

Throws:

IOException - For IO exception while reading file.

FileDownload

public FileDownload(FileDownload.Mode mode,
 @NonNull
 Path file)
             throws IOException

Creates a new file attachment.

Parameters:

mode - Download mode.

file - File content.

Throws:

IOException - For IO exception while reading file.

Method Details

getFileSize

public long getFileSize()

File size or -1 if unknown.

Returns:

File size or -1 if unknown.

getContentType

public MediaType getContentType()

File content type.

Returns:

File content type.

getFileName

public String getFileName()

File name.

Returns:

File name.

getContentDisposition

public String getContentDisposition()

Content disposition header.

Returns:

Content disposition header.

stream

public InputStream stream()

File content.

Returns:

File content.

toString

public String toString()

Overrides:

toString in class Object

build

public static FileDownload.Builder build(@NonNull
 InputStream content,
 @NonNull
 String fileName,
 long fileSize)

Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.

Parameters:

content - File content.

fileName - Filename.

fileSize - File size or -1 if unknown.

Returns:

a FileDownload.Builder with the specified content

build

public static FileDownload.Builder build(@NonNull
 InputStream content,
 @NonNull
 String fileName)

Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.

Parameters:

content - File content.

fileName - Filename.

Returns:

a FileDownload.Builder with the specified content

build

public static FileDownload.Builder build(@NonNull
 byte[] content,
 @NonNull
 String fileName)

Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.

Parameters:

content - File content.

fileName - Filename.

Returns:

a FileDownload.Builder with the specified content

build

public static FileDownload.Builder build(@NonNull
 Path file,
 @NonNull
 String fileName)

Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.

Parameters:

file - File content.

fileName - Filename.

Returns:

a FileDownload.Builder with the specified content

build

public static FileDownload.Builder build(@NonNull
 Path file)

Creates a builder with the specified content which can be used to create a FileDownload with any FileDownload.Mode.

Parameters:

file - File content.

Returns:

a FileDownload.Builder with the specified content