Package com.atlassian.bitbucket.scm

Class EditFileCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.EditFileCommandParameters

public class EditFileCommandParameters
extends AbstractCommandParameters

Parameters for editing a file.

Since:

4.13

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditFileCommandParameters.Builder

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Constructor	Description
EditFileCommandParameters(EditFileCommandParameters.Builder builder)

Method Summary

Modifier and Type	Method	Description
ApplicationUser	getAuthor()
Optional<Branch>	getBranch()
ApplicationUser	getCommitter()
InputSupplier<InputStream>	getContent()
String	getMessage()
String	getPath()
Optional<String>	getSourceCommitId()
String	getTargetBranch()

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

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

Constructor Details

EditFileCommandParameters

public EditFileCommandParameters(EditFileCommandParameters.Builder builder)

Method Details

getAuthor

@Nonnull
public ApplicationUser getAuthor()

getBranch

@Nonnull
public Optional<Branch> getBranch()

Returns:

the branch from which the file edit should be performed

getCommitter

@Nonnull
public ApplicationUser getCommitter()

Since:

7.13

getContent

@Nonnull
public InputSupplier<InputStream> getContent()

getMessage

@Nonnull
public String getMessage()

getPath

@Nonnull
public String getPath()

getSourceCommitId

@Nonnull
public Optional<String> getSourceCommitId()

getTargetBranch

@Nonnull
public String getTargetBranch()

Returns:

the name of the target branch

Since:

5.2