Package com.atlassian.jira.issue.attachment

Class CreateAttachmentParamsBean.Builder

java.lang.Object

com.atlassian.jira.issue.attachment.CreateAttachmentParamsBean.Builder

Enclosing class:

CreateAttachmentParamsBean

@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
public static class CreateAttachmentParamsBean.Builder
extends Object

Builder for CreateAttachmentParamsBean

Constructor Summary

Constructors

Constructor	Description
Builder()	Create a new builder with no parameters set.
Builder(File file, String filename, String contentType, ApplicationUser author, Issue issue)	Create a new builder with the specified parameters.

Method Summary

Modifier and Type	Method	Description
CreateAttachmentParamsBean.Builder	attachmentProperties(Map<String,Object> attachmentProperties)
CreateAttachmentParamsBean.Builder	author(ApplicationUser author)
CreateAttachmentParamsBean	build()
CreateAttachmentParamsBean.Builder	contentType(String contentType)
CreateAttachmentParamsBean.Builder	copySourceFile(Boolean copySourceFile)
CreateAttachmentParamsBean.Builder	createdTime(Date createdTime)
CreateAttachmentParamsBean.Builder	file(File file)
CreateAttachmentParamsBean.Builder	filename(String filename)
CreateAttachmentParamsBean.Builder	issue(Issue issue)
CreateAttachmentParamsBean.Builder	thumbnailable(Boolean thumbnailable)
CreateAttachmentParamsBean.Builder	zip(Boolean zip)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Create a new builder with no parameters set. The createdTime property defaults to the current timestamp.

Builder

public Builder(File file,
 String filename,
 @Nullable
 String contentType,
 @Nullable
 ApplicationUser author,
 Issue issue)

Create a new builder with the specified parameters. The createdTime property defaults to the current timestamp.

Parameters:

file - A file on a locally accessible filesystem

filename - The desired filename for this attachment. This may be different to the filename on disk (for example with temp files used in file uploads)

contentType - The desired contentType.

author - The user who created this attachment

issue - The issue that this file is to be attached to

Method Details

file

public CreateAttachmentParamsBean.Builder file(File file)

Parameters:

file - A file on a locally accessible filesystem

Returns:

this

filename

public CreateAttachmentParamsBean.Builder filename(String filename)

Parameters:

filename - The desired filename for this attachment. This may be different to the filename on disk (for example with temp files used in file uploads)

Returns:

this

contentType

public CreateAttachmentParamsBean.Builder contentType(@Nullable
 String contentType)

Parameters:

contentType - The desired contentType.

Returns:

this

author

public CreateAttachmentParamsBean.Builder author(@Nullable
 ApplicationUser author)

Parameters:

author - The user who created this attachment

Returns:

this

issue

public CreateAttachmentParamsBean.Builder issue(Issue issue)

Parameters:

issue - The issue this file will be attached to

Returns:

this

zip

public CreateAttachmentParamsBean.Builder zip(@Nullable
 Boolean zip)

Parameters:

zip - This file is a zip file. Null indicates that it is not know if this attachment is a zip file or not

Returns:

this

thumbnailable

public CreateAttachmentParamsBean.Builder thumbnailable(@Nullable
 Boolean thumbnailable)

Parameters:

thumbnailable - This file is thumbnailable (e.g. a png image). Null indicates that it is not know if this attachment is thumbnailable or not

Returns:

this

attachmentProperties

public CreateAttachmentParamsBean.Builder attachmentProperties(@Nullable
 Map<String,Object> attachmentProperties)

Parameters:

attachmentProperties - Attachment properties (a Map of String -> Object properties). These are optional, and are used to populate a PropertySet on the Attachment (Attachment.getProperties(). Null represents an empty property set.

Returns:

this

createdTime

public CreateAttachmentParamsBean.Builder createdTime(Date createdTime)

Parameters:

createdTime - The created time

Returns:

this

copySourceFile

public CreateAttachmentParamsBean.Builder copySourceFile(@Nullable
 Boolean copySourceFile)

Parameters:

copySourceFile - The source file should remain in file system. Null or false indicates that it should be removed.

Returns:

this

build

public CreateAttachmentParamsBean build()