Package com.google.gerrit.server.submit

Class SubscriptionGraph

java.lang.Object

com.google.gerrit.server.submit.SubscriptionGraph

public class SubscriptionGraph
extends Object

A container which stores subscription relationship. A SubscriptionGraph is calculated every time changes are pushed. Some branches are updated in these changes, and if these branches are subscribed by other projects, SubscriptionGraph would record information about these updated branches and branches/projects affected.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubscriptionGraph.DefaultFactory
static interface	SubscriptionGraph.Factory
static class	SubscriptionGraph.Module

Constructor Summary

Constructors

Constructor	Description
SubscriptionGraph(Set<BranchNameKey> updatedBranches, com.google.common.collect.SetMultimap<BranchNameKey,SubmoduleSubscription> targets, com.google.common.collect.SetMultimap<Project.NameKey,BranchNameKey> branchesByProject, Set<BranchNameKey> subscribedBranches, Set<BranchNameKey> sortedBranches)

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableSet<BranchNameKey>	getAffectedSuperBranches(Project.NameKey project)	Returns all branches within the superproject project which have submodule subscriptions.
com.google.common.collect.ImmutableSet<Project.NameKey>	getAffectedSuperProjects()	Get all superprojects affected.
com.google.common.collect.ImmutableSet<BranchNameKey>	getSortedSuperprojectAndSubmoduleBranches()	Get all affected branches, including the submodule branches and superproject branches, sorted by traversal order.
com.google.common.collect.ImmutableSet<SubmoduleSubscription>	getSubscriptions(BranchNameKey branch)	Get all related SubmoduleSubscriptions whose super branch is branch.
com.google.common.collect.ImmutableSet<BranchNameKey>	getUpdatedBranches()	Get branches updated as part of the enclosing submit or push batch.
boolean	hasSubscription(BranchNameKey branch)	See if a branch is a superproject branch affected.
boolean	hasSuperproject(BranchNameKey branch)	Check if a branch is a submodule of a superproject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionGraph

public SubscriptionGraph(Set<BranchNameKey> updatedBranches,
                         com.google.common.collect.SetMultimap<BranchNameKey,SubmoduleSubscription> targets,
                         com.google.common.collect.SetMultimap<Project.NameKey,BranchNameKey> branchesByProject,
                         Set<BranchNameKey> subscribedBranches,
                         Set<BranchNameKey> sortedBranches)

Method Detail

getUpdatedBranches

public com.google.common.collect.ImmutableSet<BranchNameKey> getUpdatedBranches()

Get branches updated as part of the enclosing submit or push batch.

getAffectedSuperProjects

public com.google.common.collect.ImmutableSet<Project.NameKey> getAffectedSuperProjects()

Get all superprojects affected.

getAffectedSuperBranches

public com.google.common.collect.ImmutableSet<BranchNameKey> getAffectedSuperBranches(Project.NameKey project)

Returns all branches within the superproject project which have submodule subscriptions.

getSortedSuperprojectAndSubmoduleBranches

public com.google.common.collect.ImmutableSet<BranchNameKey> getSortedSuperprojectAndSubmoduleBranches()

Get all affected branches, including the submodule branches and superproject branches, sorted by traversal order.

See Also:

sortedBranches

hasSuperproject

public boolean hasSuperproject(BranchNameKey branch)

Check if a branch is a submodule of a superproject.

hasSubscription

public boolean hasSubscription(BranchNameKey branch)

See if a branch is a superproject branch affected.

getSubscriptions

public com.google.common.collect.ImmutableSet<SubmoduleSubscription> getSubscriptions(BranchNameKey branch)

Get all related SubmoduleSubscriptions whose super branch is branch.