Package com.atlassian.bitbucket.scm

Enum Class ScmFeature

java.lang.Object

java.lang.Enum<ScmFeature>

com.atlassian.bitbucket.scm.ScmFeature

All Implemented Interfaces:

Serializable, Comparable<ScmFeature>, Constable

public enum ScmFeature
extends Enum<ScmFeature>

Enumerates optional features an SCM can support.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARCHIVE	Indicates the SCM supports streaming archives.
BULK_COMMITS	Indicates the SCM supports bulk commit retrieval.
BULK_CONTENT	Indicates the SCM supports bulk content retrieval.
BULK_TRAVERSAL	Indicates the SCM supports bulk commit traversal.
COMMAND_BUILDERS	Indicates the SCM supports builders.
COMPARE	Indicates the SCM provides a command factory to compare refs.
CROSS_REPOSITORY	Indicates the SCM supports cross-repository operations.
EDIT_FILE	Indicates the SCM supports file edit operations.
FORK	Indicates the SCM supports forking its repositories.
HOOKS	Deprecated. in 8.0 for removal when the classic SCM is removed
INTEGRITY_CHECKS	Indicates the SCM supports integrity checks
LAST_MODIFIED	Indicates the SCM supports streaming the last modification for files.
MERGE	Indicates the SCM supports merging branches.
MERGE_STRATEGIES	Indicates the SCM supports selectable merge strategies.
MIRRORS	Indicates the SCM supports mirroring repositories
PATCH	Indicates the SCM supports streaming patches.
PULL_REQUESTS	Indicates the SCM provides a command factory to create, view and merge pull requests.
PUSH	Indicates the SCM supports pushing local repositories to an URL.
REFS	Indicates the SCM provides a command factory to create branches and tags.
REVERT	Indicates the SCM supports reverting changes in a repository.
SIGNED_OBJECTS	Indicates the SCM supports retrieving signed objects.
UPDATE_DEFAULT_BRANCH	Indicates the SCM supports updating the default branch in its repositories.

Method Summary

Modifier and Type	Method	Description
static ScmFeature	parse(String value)
static ScmFeature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScmFeature[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARCHIVE

public static final ScmFeature ARCHIVE

Indicates the SCM supports streaming archives.

Since:

5.1

See Also:

• ContentService.streamArchive(ArchiveRequest, TypeAwareOutputSupplier)
• ScmExtendedCommandFactory.archive(ArchiveCommandParameters, TypeAwareOutputSupplier)

BULK_COMMITS

public static final ScmFeature BULK_COMMITS

Indicates the SCM supports bulk commit retrieval.

Since:

5.8

See Also:

• CommitService.streamCommits(BulkCommitsRequest, BulkCommitCallback)
• ScmBulkContentCommandFactory.commits(com.atlassian.bitbucket.scm.bulk.BulkCommitsCommandParameters, com.atlassian.bitbucket.scm.bulk.BulkCommitCallback)

BULK_CONTENT

public static final ScmFeature BULK_CONTENT

Indicates the SCM supports bulk content retrieval.

Since:

4.2

See Also:

• ScmBulkContentCommandFactory.contents(com.atlassian.bitbucket.scm.bulk.BulkContentCommandParameters, com.atlassian.bitbucket.scm.bulk.BulkContentCallback)
• ScmService.getBulkContentCommandFactory(Repository)

BULK_TRAVERSAL

public static final ScmFeature BULK_TRAVERSAL

Indicates the SCM supports bulk commit traversal.

Since:

5.11

See Also:

• ScmBulkContentCommandFactory.traverseCommits(BulkTraverseCommitsCommandParameters, BulkTraversalCallback)

COMMAND_BUILDERS

public static final ScmFeature COMMAND_BUILDERS

Indicates the SCM supports builders.

See Also:

• ScmService.createBuilder(Repository)

COMPARE

public static final ScmFeature COMPARE

Indicates the SCM provides a command factory to compare refs.

Note: SCMs may support comparing refs cross-repository, but they are not required to do so.

See Also:

• ScmService.getCompareCommandFactory(CompareRequest)

CROSS_REPOSITORY

public static final ScmFeature CROSS_REPOSITORY

Indicates the SCM supports cross-repository operations. This feature applies to:

• COMPARE
• MERGE
• PULL_REQUESTS

Implementing these features in a cross-repository manner may involve substantial additional complexity, so SCMs are free not to. When this feature is not supported, providing a secondary repository on commands like commits or opening a pull request between two repositories will fail.

See Also:

• COMPARE
• FORK
• MERGE
• PULL_REQUESTS

EDIT_FILE

public static final ScmFeature EDIT_FILE

Indicates the SCM supports file edit operations.

Since:

4.13

See Also:

• ScmExtendedCommandFactory.editFile(EditFileCommandParameters)

FORK

public static final ScmFeature FORK

Indicates the SCM supports forking its repositories.

SCMs which do not support forking will not support cross-repository operations, but just because forking is supported does not imply cross-repository support. The complexity of cross-repository operations can be substantially higher than the complexity of creating forks, for some SCMs, and forks can still offer value (for example, a sandboxed place to work) even if cross-repository operations are not possible.

See Also:

• RepositoryService.fork(RepositoryForkRequest)
• CROSS_REPOSITORY

HOOKS

@Deprecated
public static final ScmFeature HOOKS

Deprecated.

in 8.0 for removal when the classic SCM is removed

Indicates the SCM provides a handler factory to apply repository-level hooks. Support for this feature has been removed in 8.0

INTEGRITY_CHECKS

public static final ScmFeature INTEGRITY_CHECKS

Indicates the SCM supports integrity checks

Since:

4.12

LAST_MODIFIED

public static final ScmFeature LAST_MODIFIED

Indicates the SCM supports streaming the last modification for files.

Since:

4.6

See Also:

• CommitService.streamLastModified(LastModifiedRequest, LastModifiedCallback)

MERGE

public static final ScmFeature MERGE

Indicates the SCM supports merging branches.

Note: SCMs may support cross-repository merges, merging a branch from one repository to a target branch in another, but they are not required to do so.

See Also:

• ScmExtendedCommandFactory.merge(MergeCommandParameters)
• CROSS_REPOSITORY

MERGE_STRATEGIES

public static final ScmFeature MERGE_STRATEGIES

Indicates the SCM supports selectable merge strategies. Only SCMs which support merge commands and/or pull requests should mark this feature as supported.

Generally an SCM should support at least two strategies if this feature is enabled since, with only a single strategy, the strategy isn't actually selectable. But the only requirement of this feature is that the SCM must support at least one strategy.

Since:

4.9

MIRRORS

public static final ScmFeature MIRRORS

Indicates the SCM supports mirroring repositories

Since:

4.1

See Also:

• ScmService.getMirrorCommandFactory(Repository)

PATCH

public static final ScmFeature PATCH

Indicates the SCM supports streaming patches.

Since:

6.7

See Also:

• ContentService.streamPatch(PatchRequest, TypeAwareOutputSupplier)
• ScmExtendedCommandFactory.patch(PatchCommandParameters, TypeAwareOutputSupplier)

PULL_REQUESTS

public static final ScmFeature PULL_REQUESTS

Indicates the SCM provides a command factory to create, view and merge pull requests.

Note: SCMs may support cross-repository pull requests, merging commits from one repository into another, but they are not required to do so.

See Also:

• ScmService.getPullRequestCommandFactory(PullRequest)
• CROSS_REPOSITORY

PUSH

public static final ScmFeature PUSH

Indicates the SCM supports pushing local repositories to an URL.

Since:

7.11

See Also:

• ScmExtendedCommandFactory.push(com.atlassian.bitbucket.scm.PushCommandParameters, com.atlassian.bitbucket.scm.PushCallback)

REFS

public static final ScmFeature REFS

Indicates the SCM provides a command factory to create branches and tags.

See Also:

• ScmService.getRefCommandFactory(Repository)

REVERT

public static final ScmFeature REVERT

Indicates the SCM supports reverting changes in a repository.

Since:

8.13

See Also:

• ScmExtendedCommandFactory.revert(RevertCommandParameters)

SIGNED_OBJECTS

public static final ScmFeature SIGNED_OBJECTS

Indicates the SCM supports retrieving signed objects.

Since:

5.1

UPDATE_DEFAULT_BRANCH

public static final ScmFeature UPDATE_DEFAULT_BRANCH

Indicates the SCM supports updating the default branch in its repositories.

See Also:

• RefService.setDefaultBranch(Repository, String)

Method Details

values

public static ScmFeature[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScmFeature valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

parse

@Nonnull
public static ScmFeature parse(@Nonnull
 String value)