public class

CommitsCommandParameters

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

Summary

Nested Classes
class CommitsCommandParameters.Builder  
Constants
int UNLIMITED_MESSAGE_LENGTH This constant is deprecated. in 4.6 for removal in 5.0. Use UNLIMITED_MESSAGE_LENGTH instead.
[Expand]
Inherited Fields
From class com.atlassian.bitbucket.util.BuilderSupport
Public Methods
@Nonnull Set<String> getExcludes()
@Nonnull Set<String> getIncludes()
int getMaxMessageLength()
@Nonnull CommitListMergeFilter getMerges()
Retrieves the strategy being used to filter merge commits.
@Nonnull Set<String> getPaths()
@Nonnull Repository getSecondaryRepository()
boolean hasExcludes()
boolean hasIncludes()
boolean hasPaths()
boolean hasSecondaryRepository()
boolean isAll()
boolean isFollowingRenames()
Whether or not the commit history will attempt to follow renames.
@Nullable @Deprecated Boolean isIgnoringMissing()
This method is deprecated. in 4.5. This return type will change to boolean in 5.0.
boolean isTraversing()
boolean isWithMessages()
@Nonnull CommitContext toContext()
Assembles a CommitContext from these parameters.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.util.BuilderSupport
From class java.lang.Object

Constants

public static final int UNLIMITED_MESSAGE_LENGTH

This constant is deprecated.
in 4.6 for removal in 5.0. Use UNLIMITED_MESSAGE_LENGTH instead.

Constant Value: -1 (0xffffffff)

Public Methods

@Nonnull public Set<String> getExcludes ()

@Nonnull public Set<String> getIncludes ()

public int getMaxMessageLength ()

Returns
  • the maximum length to read for commit messages; if set, messages longer than this will be truncated; -1 indicates unlimited message length

@Nonnull public CommitListMergeFilter getMerges ()

Retrieves the strategy being used to filter merge commits.

Returns
  • how merge commits will be filtered

@Nonnull public Set<String> getPaths ()

@Nonnull public Repository getSecondaryRepository ()

public boolean hasExcludes ()

public boolean hasIncludes ()

public boolean hasPaths ()

public boolean hasSecondaryRepository ()

public boolean isAll ()

public boolean isFollowingRenames ()

Whether or not the commit history will attempt to follow renames. This is only applicable for individual file paths

Returns
  • true if renames are followed, false otherwise

@Nullable @Deprecated public Boolean isIgnoringMissing ()

This method is deprecated.
in 4.5. This return type will change to boolean in 5.0.

Returns
  • whether or not to ignore missing commits, or null to let the application figure out whether to do so.

public boolean isTraversing ()

public boolean isWithMessages ()

Returns
  • true if the comment messages should be retrieved. false otherwise.

@Nonnull public CommitContext toContext ()

Assembles a CommitContext from these parameters.

Returns