ProjectState (Gerrit Review Plugin API Documentation)

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

public class ProjectState
extends Object

Cached information on a project.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ProjectState.Factory

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ProjectState.Factory`

Constructor Summary

Constructors
Constructor and Description
`ProjectState(SitePaths sitePaths, ProjectCache projectCache, AllProjectsName allProjectsName, com.google.gerrit.server.project.ProjectControl.AssistedFactory projectControlFactory, PrologEnvironment.Factory envFactory, GitRepositoryManager gitMgr, RulesCache rulesCache, List<CommentLinkInfo> commentLinks, ProjectConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`ProjectControl`	`controlFor(CurrentUser user)`
`CapabilityCollection`	`getCapabilityCollection()`
`List<CommentLinkInfo>`	`getCommentLinks()`
`ProjectConfig`	`getConfig()`
`ProjectLevelConfig`	`getConfig(String fileName)`
`com.google.gerrit.common.data.LabelTypes`	`getLabelTypes()`
`long`	`getMaxObjectSizeLimit()`
`Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID>`	`getOwners()`
`com.google.gerrit.reviewdb.client.Project`	`getProject()`
`ThemeInfo`	`getTheme()`
`boolean`	`isAllProjects()`
`boolean`	`isRequireChangeID()`
`boolean`	`isUseContentMerge()`
`boolean`	`isUseContributorAgreements()`
`boolean`	`isUseSignedOffBy()`
`PrologEnvironment`	`newPrologEnvironment()`
`PrologEnvironment`	`newPrologEnvironment(String name, InputStream in)` Like `newPrologEnvironment()` but instead of reading the rules.pl read the provided input stream.
`Iterable<ProjectState>`	`parents()`
`Iterable<ProjectState>`	`tree()`
`Iterable<ProjectState>`	`treeInOrder()`

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

Constructor Detail

ProjectState

@Inject
public ProjectState(SitePaths sitePaths,
                   ProjectCache projectCache,
                   AllProjectsName allProjectsName,
                   com.google.gerrit.server.project.ProjectControl.AssistedFactory projectControlFactory,
                   PrologEnvironment.Factory envFactory,
                   GitRepositoryManager gitMgr,
                   RulesCache rulesCache,
                   List<CommentLinkInfo> commentLinks,
                   ProjectConfig config)

Method Detail
- getCapabilityCollection
```
public CapabilityCollection getCapabilityCollection()
```
  Returns:
  cached computation of all global capabilities. This should only be invoked on the state from ProjectCache.getAllProjects(). Null on any other project.
- newPrologEnvironment
```
public PrologEnvironment newPrologEnvironment()
                                       throws com.googlecode.prolog_cafe.compiler.CompileException
```
  Returns:
  Construct a new PrologEnvironment for the calling thread.
  
  Throws:
  
  com.googlecode.prolog_cafe.compiler.CompileException
- newPrologEnvironment
```
public PrologEnvironment newPrologEnvironment(String name,
                                     InputStream in)
                                       throws com.googlecode.prolog_cafe.compiler.CompileException
```
  Like newPrologEnvironment() but instead of reading the rules.pl read the provided input stream.
  
  Parameters:
  name - a name of the input stream. Could be any name.
  in - InputStream to read prolog rules from
  
  Throws:
  
  com.googlecode.prolog_cafe.compiler.CompileException
- getProject
```
public com.google.gerrit.reviewdb.client.Project getProject()
```
- getConfig
```
public ProjectConfig getConfig()
```
- getConfig
```
public ProjectLevelConfig getConfig(String fileName)
```
- getMaxObjectSizeLimit
```
public long getMaxObjectSizeLimit()
```
- getOwners
```
public Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID> getOwners()
```
  Returns:
  all AccountGroup's to which the owner privilege for 'refs/*' is assigned for this project (the local owners), if there are no local owners the local owners of the nearest parent project that has local owners are returned
- controlFor
```
public ProjectControl controlFor(CurrentUser user)
```
- tree
```
public Iterable<ProjectState> tree()
```
  Returns:
  an iterable that walks through this project and then the parents of this project. Starts from this project and progresses up the hierarchy to All-Projects.
- treeInOrder
```
public Iterable<ProjectState> treeInOrder()
```
  Returns:
  an iterable that walks in-order from All-Projects through the project hierarchy to this project.
- parents
```
public Iterable<ProjectState> parents()
```
  Returns:
  an iterable that walks through the parents of this project. Starts from the immediate parent of this project and progresses up the hierarchy to All-Projects.
- isAllProjects
```
public boolean isAllProjects()
```
- isUseContributorAgreements
```
public boolean isUseContributorAgreements()
```
- isUseContentMerge
```
public boolean isUseContentMerge()
```
- isUseSignedOffBy
```
public boolean isUseSignedOffBy()
```
- isRequireChangeID
```
public boolean isRequireChangeID()
```
- getLabelTypes
```
public com.google.gerrit.common.data.LabelTypes getLabelTypes()
```
- getCommentLinks
```
public List<CommentLinkInfo> getCommentLinks()
```
- getTheme
```
public ThemeInfo getTheme()
```

Class ProjectState

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProjectState

Method Detail

getCapabilityCollection

newPrologEnvironment

newPrologEnvironment

getProject

getConfig

getConfig

getMaxObjectSizeLimit

getOwners

controlFor

tree

treeInOrder

parents

isAllProjects

isUseContributorAgreements

isUseContentMerge

isUseSignedOffBy

isRequireChangeID

getLabelTypes

getCommentLinks

getTheme