public class

EditFileCommandParameters

extends AbstractCommandParameters
java.lang.Object
   ↳ com.atlassian.bitbucket.util.BuilderSupport
     ↳ com.atlassian.bitbucket.scm.AbstractCommandParameters
       ↳ com.atlassian.bitbucket.scm.EditFileCommandParameters

Class Overview

Parameters for editing a file.

Summary

Nested Classes
class EditFileCommandParameters.Builder  
[Expand]
Inherited Fields
From class com.atlassian.bitbucket.util.BuilderSupport
Public Constructors
EditFileCommandParameters(EditFileCommandParameters.Builder builder)
Public Methods
@Nonnull ApplicationUser getAuthor()
@Deprecated @Nullable Branch getBranch()
This method is deprecated. since 5.2 when the return value was changed from @Nonnull to @Nullable. Will be replaced with an Optional<Branch> return type in 6.0
@Nonnull InputSupplier<InputStream> getContent()
@Nonnull String getMessage()
@Nonnull String getPath()
@Nonnull Optional<String> getSourceCommitId()
@Nonnull String getTargetBranch()
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.util.BuilderSupport
From class java.lang.Object

Public Constructors

public EditFileCommandParameters (EditFileCommandParameters.Builder builder)

Public Methods

@Nonnull public ApplicationUser getAuthor ()

@Deprecated @Nullable public Branch getBranch ()

This method is deprecated.
since 5.2 when the return value was changed from @Nonnull to @Nullable. Will be replaced with an Optional<Branch> return type in 6.0

Returns
  • the branch from which the file edit should be performed

@Nonnull public InputSupplier<InputStream> getContent ()

@Nonnull public String getMessage ()

@Nonnull public String getPath ()

@Nonnull public Optional<String> getSourceCommitId ()

@Nonnull public String getTargetBranch ()

Returns
  • the name of the target branch