com.atlassian.bitbucket.scm

Class ResolveRefsCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.ResolveRefsCommandParameters

public class ResolveRefsCommandParameters
extends AbstractCommandParameters

Describes which refs to resolve.

If it is known whether a requested ref is a branch or a tag, the caller is encouraged to use either the ResolveRefsCommandParameters.Builder.branchId(String) or ResolveRefsCommandParameters.Builder.tagId(String) method to allow the SCM to optimize resolving the ref. If the ref type is unknown, the ResolveRefsCommandParameters.Builder.refId(String) method should be used.

Since:

4.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolveRefsCommandParameters.Builder

Field Summary

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

NOT_BLANK

Method Summary

Modifier and Type	Method and Description
Set<String>	getBranchIds()
Set<String>	getRefIds()
Set<String>	getTagIds()

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

Method Detail

getBranchIds

@Nonnull
public Set<String> getBranchIds()

Returns:

the branch IDs to resolve

getRefIds

@Nonnull
public Set<String> getRefIds()

Returns:

the ref IDs to resolve. Could be branches or tags

getTagIds

@Nonnull
public Set<String> getTagIds()

Returns:

the tag IDs to resolve