RefControl (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.project.RefControl

```
public class RefControl
extends Object
```
Manages access control for Git references (aka branches, tags).

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canAbandon()`
`boolean`	`canCreate(org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.revwalk.RevObject object, boolean existsOnServer)` Determines whether the user can create a new Git ref.
`boolean`	`canDelete()` Determines whether the user can delete the Git ref controlled by this object.
`boolean`	`canDeleteDrafts()`
`boolean`	`canEditTopicName()`
`boolean`	`canForceEditTopicName()`
`boolean`	`canForceUpdate()`
`boolean`	`canForgeAuthor()`
`boolean`	`canForgeCommitter()`
`boolean`	`canForgeGerritServerIdentity()`
`boolean`	`canPublishDrafts()`
`boolean`	`canRead()`
`boolean`	`canRebase()`
`boolean`	`canRemoveReviewer()`
`boolean`	`canSubmit()`
`boolean`	`canSubmitAs()`
`boolean`	`canUpdate()`
`boolean`	`canUpload()` Determines whether the user can upload a change to the ref controlled by this object.
`boolean`	`canUploadMerges()`
`boolean`	`canViewDrafts()`
`boolean`	`canWrite()`
`RefControl`	`forUser(CurrentUser who)`
`CurrentUser`	`getCurrentUser()`
`List<com.google.gerrit.common.data.PermissionRange>`	`getLabelRanges(boolean isChangeOwner)` All value ranges of any allowed label permission.
`ProjectControl`	`getProjectControl()`
`com.google.gerrit.common.data.PermissionRange`	`getRange(String permission)` The range of permitted values associated with a label permission.
`com.google.gerrit.common.data.PermissionRange`	`getRange(String permission, boolean isChangeOwner)` The range of permitted values associated with a label permission.
`String`	`getRefName()`
`boolean`	`isBlocked(String permissionName)` True if the user is blocked from using this permission.
`boolean`	`isOwner()` Is this user a ref owner?
`static boolean`	`isRE(String refPattern)`
`boolean`	`isVisible()` Can this user see this reference exists?
`boolean`	`isVisibleByRegisteredUsers()` True if this reference is visible by all REGISTERED_USERS
`static String`	`shortestExample(String pattern)`
`static dk.brics.automaton.RegExp`	`toRegExp(String refPattern)`
`static void`	`validateRefPattern(String refPattern)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getRefName
```
public String getRefName()
```
  - getProjectControl
```
public ProjectControl getProjectControl()
```
  - getCurrentUser
```
public CurrentUser getCurrentUser()
```
  - forUser
```
public RefControl forUser(CurrentUser who)
```
  - isOwner
```
public boolean isOwner()
```
    Is this user a ref owner?
  - isVisible
```
public boolean isVisible()
```
    Can this user see this reference exists?
  - isVisibleByRegisteredUsers
```
public boolean isVisibleByRegisteredUsers()
```
    True if this reference is visible by all REGISTERED_USERS
  - canUpload
```
public boolean canUpload()
```
    Determines whether the user can upload a change to the ref controlled by this object.
    
    Returns:
    true if the user specified can upload a change to the Git ref
  - canUploadMerges
```
public boolean canUploadMerges()
```
    Returns:
    true if this user can submit merge patch sets to this ref
  - canRebase
```
public boolean canRebase()
```
    Returns:
    true if this user can rebase changes on this ref
  - canSubmit
```
public boolean canSubmit()
```
    Returns:
    true if this user can submit patch sets to this ref
  - canSubmitAs
```
public boolean canSubmitAs()
```
    Returns:
    true if this user was granted submitAs to this ref
  - canUpdate
```
public boolean canUpdate()
```
    Returns:
    true if the user can update the reference as a fast-forward.
  - canForceUpdate
```
public boolean canForceUpdate()
```
    Returns:
    true if the user can rewind (force push) the reference.
  - canWrite
```
public boolean canWrite()
```
  - canRead
```
public boolean canRead()
```
  - canCreate
```
public boolean canCreate(org.eclipse.jgit.revwalk.RevWalk rw,
                org.eclipse.jgit.revwalk.RevObject object,
                boolean existsOnServer)
```
    Determines whether the user can create a new Git ref.
    
    Parameters:
    rw - revision pool object was parsed in.
    object - the object the user will start the reference with.
    existsOnServer - the object exists on server or not.
    
    Returns:
    true if the user specified can create a new Git ref
  - canDelete
```
public boolean canDelete()
```
    Determines whether the user can delete the Git ref controlled by this object.
    
    Returns:
    true if the user specified can delete a Git ref.
  - canForgeAuthor
```
public boolean canForgeAuthor()
```
    Returns:
    true if this user can forge the author line in a commit.
  - canForgeCommitter
```
public boolean canForgeCommitter()
```
    Returns:
    true if this user can forge the committer line in a commit.
  - canForgeGerritServerIdentity
```
public boolean canForgeGerritServerIdentity()
```
    Returns:
    true if this user can forge the server on the committer line.
  - canAbandon
```
public boolean canAbandon()
```
    Returns:
    true if this user can abandon a change for this ref
  - canRemoveReviewer
```
public boolean canRemoveReviewer()
```
    Returns:
    true if this user can remove a reviewer for a change.
  - canViewDrafts
```
public boolean canViewDrafts()
```
    Returns:
    true if this user can view draft changes.
  - canPublishDrafts
```
public boolean canPublishDrafts()
```
    Returns:
    true if this user can publish draft changes.
  - canDeleteDrafts
```
public boolean canDeleteDrafts()
```
    Returns:
    true if this user can delete draft changes.
  - canEditTopicName
```
public boolean canEditTopicName()
```
    Returns:
    true if this user can edit topic names.
  - canForceEditTopicName
```
public boolean canForceEditTopicName()
```
    Returns:
    true if this user can force edit topic names.
  - getLabelRanges
```
public List<com.google.gerrit.common.data.PermissionRange> getLabelRanges(boolean isChangeOwner)
```
    All value ranges of any allowed label permission.
  - getRange
```
public com.google.gerrit.common.data.PermissionRange getRange(String permission)
```
    The range of permitted values associated with a label permission.
  - getRange
```
public com.google.gerrit.common.data.PermissionRange getRange(String permission,
                                                     boolean isChangeOwner)
```
    The range of permitted values associated with a label permission.
  - isBlocked
```
public boolean isBlocked(String permissionName)
```
    True if the user is blocked from using this permission.
  - isRE
```
public static boolean isRE(String refPattern)
```
  - shortestExample
```
public static String shortestExample(String pattern)
```
  - toRegExp
```
public static dk.brics.automaton.RegExp toRegExp(String refPattern)
```
  - validateRefPattern
```
public static void validateRefPattern(String refPattern)
                               throws com.google.gerrit.common.errors.InvalidNameException
```
    Throws:
    
    com.google.gerrit.common.errors.InvalidNameException

Class RefControl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRefName

getProjectControl

getCurrentUser

forUser

isOwner

isVisible

isVisibleByRegisteredUsers

canUpload

canUploadMerges

canRebase

canSubmit

canSubmitAs

canUpdate

canForceUpdate

canWrite

canRead

canCreate

canDelete

canForgeAuthor

canForgeCommitter

canForgeGerritServerIdentity

canAbandon

canRemoveReviewer

canViewDrafts

canPublishDrafts

canDeleteDrafts

canEditTopicName

canForceEditTopicName

getLabelRanges

getRange

getRange

isBlocked

isRE

shortestExample

toRegExp

validateRefPattern