RefNames (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.reviewdb.client.RefNames

```
public class RefNames
extends Object
```
Constants and utilities for Gerrit-specific ref names.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EDIT_PREFIX`
`static String`	`HEAD`
`static String`	`META_SUFFIX` Suffix of a meta ref in the NoteDb.
`static String`	`REFS`
`static String`	`REFS_CACHE_AUTOMERGE` Prefix applied to merge commit base nodes.
`static String`	`REFS_CHANGES`
`static String`	`REFS_CONFIG` Configuration settings for a project `refs/meta/config`
`static String`	`REFS_DASHBOARDS` Configurations of project-specific dashboards (canned search queries).
`static String`	`REFS_DELETED_GROUPS` NoteDb ref for deleted groups `refs/deleted-groups`.
`static String`	`REFS_DRAFT_COMMENTS` Draft inline comments of a user on a change
`static String`	`REFS_EXTERNAL_IDS` Note tree listing external IDs
`static String`	`REFS_GROUPNAMES` NoteDb ref for the NoteMap of all group names
`static String`	`REFS_GROUPS` NoteDb ref for a group `refs/groups`
`static String`	`REFS_HEADS`
`static String`	`REFS_META`
`static String`	`REFS_REJECT_COMMITS` Note tree listing commits we refuse `refs/meta/reject-commits`
`static String`	`REFS_SEQUENCES` Sequence counters in NoteDb.
`static String`	`REFS_STARRED_CHANGES` A change starred by a user
`static String`	`REFS_TAGS`
`static String`	`REFS_USERS` Preference settings for a user `refs/users`
`static String`	`REFS_USERS_DEFAULT` Default user preference settings
`static String`	`REFS_USERS_SELF` Magic user branch in All-Users `refs/users/self`
`static String`	`ROBOT_COMMENTS_SUFFIX` Suffix of a ref that stores robot comments in the NoteDb.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`changeMetaRef(Change.Id id)`
`static String`	`fullName(String ref)`
`static boolean`	`isConfigRef(String ref)` Whether the ref is the configuration branch, i.e.
`static boolean`	`isGroupRef(String ref)` Whether the ref is used for storing group data in NoteDb.
`static boolean`	`isNoteDbMetaRef(String ref)`
`static boolean`	`isRefsDeletedGroups(String ref)` Whether the ref is a group branch that stores NoteDb data of a deleted group.
`static boolean`	`isRefsEdit(String ref)`
`static boolean`	`isRefsGroups(String ref)` Whether the ref is a group branch that stores NoteDb data of a group.
`static boolean`	`isRefsUsers(String ref)`
`static String`	`refsCacheAutomerge(String hash)`
`static String`	`refsDeletedGroups(AccountGroup.UUID groupUuid)`
`static String`	`refsDraftComments(Change.Id changeId, Account.Id accountId)`
`static String`	`refsDraftCommentsPrefix(Change.Id changeId)`
`static String`	`refsEdit(Account.Id accountId, Change.Id changeId, PatchSet.Id psId)` Returns reference for this change edit with sharded user and change number: refs/users/UU/UUUU/edit-CCCC/P.
`static String`	`refsEditPrefix(Account.Id accountId)`
`static String`	`refsEditPrefix(Account.Id accountId, Change.Id changeId)` Returns reference prefix for this change edit with sharded user and change number: refs/users/UU/UUUU/edit-CCCC/.
`static String`	`refsGroups(AccountGroup.UUID groupUuid)`
`static String`	`refsStarredChanges(Change.Id changeId, Account.Id accountId)`
`static String`	`refsStarredChangesPrefix(Change.Id changeId)`
`static String`	`refsUsers(Account.Id accountId)`
`static String`	`robotCommentsRef(Change.Id id)`
`static String`	`shard(int id)`
`static String`	`shortName(String ref)`

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

- Field Detail
  - HEAD
```
public static final String HEAD
```
    See Also:
    
    Constant Field Values
  - REFS
```
public static final String REFS
```
    See Also:
    
    Constant Field Values
  - REFS_HEADS
```
public static final String REFS_HEADS
```
    See Also:
    
    Constant Field Values
  - REFS_TAGS
```
public static final String REFS_TAGS
```
    See Also:
    
    Constant Field Values
  - REFS_CHANGES
```
public static final String REFS_CHANGES
```
    See Also:
    
    Constant Field Values
  - REFS_META
```
public static final String REFS_META
```
    See Also:
    
    Constant Field Values
  - REFS_REJECT_COMMITS
```
public static final String REFS_REJECT_COMMITS
```
    Note tree listing commits we refuse refs/meta/reject-commits
    
    See Also:
    
    Constant Field Values
  - REFS_CONFIG
```
public static final String REFS_CONFIG
```
    Configuration settings for a project refs/meta/config
    
    See Also:
    
    Constant Field Values
  - REFS_EXTERNAL_IDS
```
public static final String REFS_EXTERNAL_IDS
```
    Note tree listing external IDs
    
    See Also:
    
    Constant Field Values
  - REFS_USERS_SELF
```
public static final String REFS_USERS_SELF
```
    Magic user branch in All-Users refs/users/self
    
    See Also:
    
    Constant Field Values
  - REFS_USERS_DEFAULT
```
public static final String REFS_USERS_DEFAULT
```
    Default user preference settings
    
    See Also:
    
    Constant Field Values
  - REFS_DASHBOARDS
```
public static final String REFS_DASHBOARDS
```
    Configurations of project-specific dashboards (canned search queries).
    
    See Also:
    
    Constant Field Values
  - REFS_SEQUENCES
```
public static final String REFS_SEQUENCES
```
    Sequence counters in NoteDb.
    
    See Also:
    
    Constant Field Values
  - REFS_CACHE_AUTOMERGE
```
public static final String REFS_CACHE_AUTOMERGE
```
    Prefix applied to merge commit base nodes.
    References in this directory should take the form refs/cache-automerge/xx/yyyy... where xx is the first two digits of the merge commit's object name, and yyyyy... is the remaining 38. The reference should point to a treeish that is the automatic merge result of the merge commit's parents.
    
    See Also:
    
    Constant Field Values
  - META_SUFFIX
```
public static final String META_SUFFIX
```
    Suffix of a meta ref in the NoteDb.
    
    See Also:
    
    Constant Field Values
  - ROBOT_COMMENTS_SUFFIX
```
public static final String ROBOT_COMMENTS_SUFFIX
```
    Suffix of a ref that stores robot comments in the NoteDb.
    
    See Also:
    
    Constant Field Values
  - EDIT_PREFIX
```
public static final String EDIT_PREFIX
```
    See Also:
    
    Constant Field Values
  - REFS_USERS
```
public static final String REFS_USERS
```
    Preference settings for a user refs/users
    
    See Also:
    
    Constant Field Values
  - REFS_GROUPS
```
public static final String REFS_GROUPS
```
    NoteDb ref for a group refs/groups
    
    See Also:
    
    Constant Field Values
  - REFS_GROUPNAMES
```
public static final String REFS_GROUPNAMES
```
    NoteDb ref for the NoteMap of all group names
    
    See Also:
    
    Constant Field Values
  - REFS_DELETED_GROUPS
```
public static final String REFS_DELETED_GROUPS
```
    NoteDb ref for deleted groups refs/deleted-groups. This ref namespace is foreseen as an attic for deleted groups (it's reserved but not used yet)
    
    See Also:
    
    Constant Field Values
  - REFS_DRAFT_COMMENTS
```
public static final String REFS_DRAFT_COMMENTS
```
    Draft inline comments of a user on a change
    
    See Also:
    
    Constant Field Values
  - REFS_STARRED_CHANGES
```
public static final String REFS_STARRED_CHANGES
```
    A change starred by a user
    
    See Also:
    
    Constant Field Values
- Method Detail
  - fullName
```
public static String fullName(String ref)
```
  - shortName
```
public static final String shortName(String ref)
```
  - changeMetaRef
```
public static String changeMetaRef(Change.Id id)
```
  - robotCommentsRef
```
public static String robotCommentsRef(Change.Id id)
```
  - isNoteDbMetaRef
```
public static boolean isNoteDbMetaRef(String ref)
```
  - refsGroups
```
public static String refsGroups(AccountGroup.UUID groupUuid)
```
  - refsDeletedGroups
```
public static String refsDeletedGroups(AccountGroup.UUID groupUuid)
```
  - refsUsers
```
public static String refsUsers(Account.Id accountId)
```
  - refsDraftComments
```
public static String refsDraftComments(Change.Id changeId,
                                       Account.Id accountId)
```
  - refsDraftCommentsPrefix
```
public static String refsDraftCommentsPrefix(Change.Id changeId)
```
  - refsStarredChanges
```
public static String refsStarredChanges(Change.Id changeId,
                                        Account.Id accountId)
```
  - refsStarredChangesPrefix
```
public static String refsStarredChangesPrefix(Change.Id changeId)
```
  - refsCacheAutomerge
```
public static String refsCacheAutomerge(String hash)
```
  - shard
```
public static String shard(int id)
```
  - refsEdit
```
public static String refsEdit(Account.Id accountId,
                              Change.Id changeId,
                              PatchSet.Id psId)
```
    Returns reference for this change edit with sharded user and change number: refs/users/UU/UUUU/edit-CCCC/P.
    
    Parameters:
    
    accountId - account id
    
    changeId - change number
    
    psId - patch set number
    
    Returns:
    
    reference for this change edit
  - refsEditPrefix
```
public static String refsEditPrefix(Account.Id accountId,
                                    Change.Id changeId)
```
    Returns reference prefix for this change edit with sharded user and change number: refs/users/UU/UUUU/edit-CCCC/.
    
    Parameters:
    
    accountId - account id
    
    changeId - change number
    
    Returns:
    
    reference prefix for this change edit
  - refsEditPrefix
```
public static String refsEditPrefix(Account.Id accountId)
```
  - isRefsEdit
```
public static boolean isRefsEdit(String ref)
```
  - isRefsUsers
```
public static boolean isRefsUsers(String ref)
```
  - isRefsGroups
```
public static boolean isRefsGroups(String ref)
```
    Whether the ref is a group branch that stores NoteDb data of a group. Returns true for all refs that start with refs/groups/.
  - isRefsDeletedGroups
```
public static boolean isRefsDeletedGroups(String ref)
```
    Whether the ref is a group branch that stores NoteDb data of a deleted group. Returns true for all refs that start with refs/deleted-groups/.
  - isGroupRef
```
public static boolean isGroupRef(String ref)
```
    Whether the ref is used for storing group data in NoteDb. Returns true for all group branches, refs/meta/group-names and deleted group branches.
  - isConfigRef
```
public static boolean isConfigRef(String ref)
```
    Whether the ref is the configuration branch, i.e. refs/meta/config, for a project.

Class RefNames

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HEAD

REFS

REFS_HEADS

REFS_TAGS

REFS_CHANGES

REFS_META

REFS_REJECT_COMMITS

REFS_CONFIG

REFS_EXTERNAL_IDS

REFS_USERS_SELF

REFS_USERS_DEFAULT

REFS_DASHBOARDS

REFS_SEQUENCES

REFS_CACHE_AUTOMERGE

META_SUFFIX

ROBOT_COMMENTS_SUFFIX

EDIT_PREFIX

REFS_USERS

REFS_GROUPS

REFS_GROUPNAMES

REFS_DELETED_GROUPS

REFS_DRAFT_COMMENTS

REFS_STARRED_CHANGES

Method Detail

fullName

shortName

changeMetaRef

robotCommentsRef

isNoteDbMetaRef

refsGroups

refsDeletedGroups

refsUsers

refsDraftComments

refsDraftCommentsPrefix

refsStarredChanges

refsStarredChangesPrefix

refsCacheAutomerge

shard

refsEdit

refsEditPrefix

refsEditPrefix

isRefsEdit

isRefsUsers

isRefsGroups

isRefsDeletedGroups

isGroupRef

isConfigRef