com.atlassian.bitbucket.scm

Class AbstractCommitCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.AbstractCommitCommandParameters

Direct Known Subclasses:

BlameCommandParameters, CommitCommandParameters, DirectoryCommandParameters, FileCommandParameters, LastModifiedCommandParameters, RawFileCommandParameters, TypeCommandParameters

public class AbstractCommitCommandParameters
extends AbstractCommandParameters

A base class for constructing CommandParameters classes for commands which operate on a specific commit, optionally qualified to a specific path.

What the commit and path mean to the end command may vary widely. Derived classes will document those meanings. Extending from this base class implies no contract beyond that:

• The commit will never be null
• The path may be null unless documented otherwise by the derived class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCommitCommandParameters.AbstractCommitParametersBuilder<B extends AbstractCommitCommandParameters.AbstractCommitParametersBuilder<B>>

Field Summary

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

NOT_BLANK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCommitCommandParameters(AbstractCommitCommandParameters.AbstractCommitParametersBuilder<?> builder)

Method Summary

Modifier and Type	Method and Description
String	getCommitId()
String	getPath()
boolean	hasPath()

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 Detail

AbstractCommitCommandParameters

protected AbstractCommitCommandParameters(AbstractCommitCommandParameters.AbstractCommitParametersBuilder<?> builder)

Method Detail

getCommitId

@Nonnull
public String getCommitId()

getPath

@Nullable
public String getPath()

hasPath

public boolean hasPath()