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  
[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 CommitOrder getOrder()
Retrieves the sort order to use for the commits.
@Nonnull Set<String> getPaths()
@Nullable 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.
boolean isIgnoringMissing()
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

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
See Also

@Nonnull public CommitOrder getOrder ()

Retrieves the sort order to use for the commits.

Returns
  • the sort order

@Nonnull public Set<String> getPaths ()

@Nullable 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

public boolean isIgnoringMissing ()

Returns
  • whether or not to ignore missing commits.

public boolean isTraversing ()

public boolean isWithMessages ()

Returns
  • true if commit messages should be included; otherwise, false if they should be omitted

@Nonnull public CommitContext toContext ()

Assembles a CommitContext from these parameters.

Returns