Package com.atlassian.bitbucket.scm

Class ResolveRefCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.ResolveRefCommandParameters

public class ResolveRefCommandParameters
extends AbstractCommandParameters

Describes a ref to resolve.

If it is known whether a requested ref is a branch or a tag, the caller is encouraged to specify the type to allow the SCM to optimize resolving the ref. If the ref type is unknown, the type should be left null.

Since:

4.6

See Also:

• StandardRefType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResolveRefCommandParameters.Builder

Field Summary

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

NOT_BLANK

Method Summary

Modifier and Type	Method	Description
String	getRefId()
Optional<RefType>	getType()

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 Details

getRefId

@Nonnull
public String getRefId()

Returns:

the branch IDs to resolve

getType

@Nonnull
public Optional<RefType> getType()

Returns:

an optional RefType, used to limit scope for matching the refId, which may empty() but never null