com.google.gerrit.reviewdb.client

Class RefNames

java.lang.Object

com.google.gerrit.reviewdb.client.RefNames

public class RefNames
extends java.lang.Object

Constants and utilities for Gerrit-specific ref names.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static java.lang.String	changeMetaRef(Change.Id id)
static java.lang.String	fullName(java.lang.String ref)
static boolean	isConfigRef(java.lang.String ref) Whether the ref is the configuration branch, i.e.
static boolean	isGerritRef(java.lang.String ref) Whether the ref is managed by Gerrit.
static boolean	isGroupRef(java.lang.String ref) Whether the ref is used for storing group data in NoteDb.
static boolean	isNoteDbMetaRef(java.lang.String ref)
static boolean	isRefsChanges(java.lang.String ref) True if the provided ref is in refs/changes/*.
static boolean	isRefsDeletedGroups(java.lang.String ref) Whether the ref is a group branch that stores NoteDb data of a deleted group.
static boolean	isRefsEdit(java.lang.String ref)
static boolean	isRefsGroups(java.lang.String ref) Whether the ref is a group branch that stores NoteDb data of a group.
static boolean	isRefsUsers(java.lang.String ref)
static java.lang.String	parseShardedUuidFromRefPart(java.lang.String name)
static java.lang.String	patchSetRef(PatchSet.Id id)
static java.lang.String	refsCacheAutomerge(java.lang.String hash)
static java.lang.String	refsDeletedGroups(AccountGroup.UUID groupUuid)
static java.lang.String	refsDraftComments(Change.Id changeId, Account.Id accountId)
static java.lang.String	refsDraftCommentsPrefix(Change.Id changeId)
static java.lang.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 java.lang.String	refsEditPrefix(Account.Id accountId)
static java.lang.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 java.lang.String	refsGroups(AccountGroup.UUID groupUuid)
static java.lang.String	refsStarredChanges(Change.Id changeId, Account.Id accountId)
static java.lang.String	refsStarredChangesPrefix(Change.Id changeId)
static java.lang.String	refsUsers(Account.Id accountId)
static java.lang.String	robotCommentsRef(Change.Id id)
static java.lang.String	shard(int id)
static java.lang.String	shardUuid(java.lang.String uuid)
static java.lang.String	shortName(java.lang.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 java.lang.String HEAD

See Also:

Constant Field Values

REFS

public static final java.lang.String REFS

See Also:

Constant Field Values

REFS_HEADS

public static final java.lang.String REFS_HEADS

See Also:

Constant Field Values

REFS_TAGS

public static final java.lang.String REFS_TAGS

See Also:

Constant Field Values

REFS_CHANGES

public static final java.lang.String REFS_CHANGES

See Also:

Constant Field Values

REFS_META

public static final java.lang.String REFS_META

See Also:

Constant Field Values

REFS_REJECT_COMMITS

public static final java.lang.String REFS_REJECT_COMMITS

Note tree listing commits we refuse refs/meta/reject-commits

See Also:

Constant Field Values

REFS_CONFIG

public static final java.lang.String REFS_CONFIG

Configuration settings for a project refs/meta/config

See Also:

Constant Field Values

REFS_EXTERNAL_IDS

public static final java.lang.String REFS_EXTERNAL_IDS

Note tree listing external IDs

See Also:

Constant Field Values

REFS_USERS_SELF

public static final java.lang.String REFS_USERS_SELF

Magic user branch in All-Users refs/users/self

See Also:

Constant Field Values

REFS_USERS_DEFAULT

public static final java.lang.String REFS_USERS_DEFAULT

Default user preference settings

See Also:

Constant Field Values

REFS_DASHBOARDS

public static final java.lang.String REFS_DASHBOARDS

Configurations of project-specific dashboards (canned search queries).

See Also:

Constant Field Values

REFS_SEQUENCES

public static final java.lang.String REFS_SEQUENCES

Sequence counters in NoteDb.

See Also:

Constant Field Values

REFS_VERSION

public static final java.lang.String REFS_VERSION

NoteDb schema version number.

See Also:

Constant Field Values

REFS_CACHE_AUTOMERGE

public static final java.lang.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 java.lang.String META_SUFFIX

Suffix of a meta ref in the NoteDb.

See Also:

Constant Field Values

ROBOT_COMMENTS_SUFFIX

public static final java.lang.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 java.lang.String EDIT_PREFIX

See Also:

Constant Field Values

REFS_USERS

public static final java.lang.String REFS_USERS

Preference settings for a user refs/users

See Also:

Constant Field Values

REFS_GROUPS

public static final java.lang.String REFS_GROUPS

NoteDb ref for a group refs/groups

See Also:

Constant Field Values

REFS_GROUPNAMES

public static final java.lang.String REFS_GROUPNAMES

NoteDb ref for the NoteMap of all group names

See Also:

Constant Field Values

REFS_DELETED_GROUPS

public static final java.lang.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 java.lang.String REFS_DRAFT_COMMENTS

Draft inline comments of a user on a change

See Also:

Constant Field Values

REFS_STARRED_CHANGES

public static final java.lang.String REFS_STARRED_CHANGES

A change starred by a user

See Also:

Constant Field Values

Method Detail

fullName

public static java.lang.String fullName(java.lang.String ref)

shortName

public static final java.lang.String shortName(java.lang.String ref)

changeMetaRef

public static java.lang.String changeMetaRef(Change.Id id)

patchSetRef

public static java.lang.String patchSetRef(PatchSet.Id id)

robotCommentsRef

public static java.lang.String robotCommentsRef(Change.Id id)

isNoteDbMetaRef

public static boolean isNoteDbMetaRef(java.lang.String ref)

isRefsChanges

public static boolean isRefsChanges(java.lang.String ref)

True if the provided ref is in refs/changes/*.

refsGroups

public static java.lang.String refsGroups(AccountGroup.UUID groupUuid)

refsDeletedGroups

public static java.lang.String refsDeletedGroups(AccountGroup.UUID groupUuid)

refsUsers

public static java.lang.String refsUsers(Account.Id accountId)

refsDraftComments

public static java.lang.String refsDraftComments(Change.Id changeId,
                                                 Account.Id accountId)

refsDraftCommentsPrefix

public static java.lang.String refsDraftCommentsPrefix(Change.Id changeId)

refsStarredChanges

public static java.lang.String refsStarredChanges(Change.Id changeId,
                                                  Account.Id accountId)

refsStarredChangesPrefix

public static java.lang.String refsStarredChangesPrefix(Change.Id changeId)

refsCacheAutomerge

public static java.lang.String refsCacheAutomerge(java.lang.String hash)

shard

public static java.lang.String shard(int id)

shardUuid

public static java.lang.String shardUuid(java.lang.String uuid)

refsEdit

public static java.lang.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 java.lang.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 java.lang.String refsEditPrefix(Account.Id accountId)

isRefsEdit

public static boolean isRefsEdit(java.lang.String ref)

isRefsUsers

public static boolean isRefsUsers(java.lang.String ref)

isRefsGroups

public static boolean isRefsGroups(java.lang.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(java.lang.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(java.lang.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(java.lang.String ref)

Whether the ref is the configuration branch, i.e. refs/meta/config, for a project.

isGerritRef

public static boolean isGerritRef(java.lang.String ref)

Whether the ref is managed by Gerrit. Covers all Gerrit-internal refs like refs/cache-automerge and refs/meta as well as refs/changes. Does not cover user-created refs like branches or custom ref namespaces like refs/my-company.

Any ref for which this method evaluates to true will be served to users who have the ACCESS_DATABASE capability.

CautionAny ref not in this list will be served if the user was granted a READ permission on it using Gerrit's permission model.

parseShardedUuidFromRefPart

public static java.lang.String parseShardedUuidFromRefPart(java.lang.String name)