ListProjects (Gerrit Review Plugin API Documentation)

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

All Implemented Interfaces:

com.google.gerrit.extensions.restapi.RestReadView<com.google.gerrit.extensions.restapi.TopLevelResource>, com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource>
```
public class ListProjects
extends java.lang.Object
implements com.google.gerrit.extensions.restapi.RestReadView<com.google.gerrit.extensions.restapi.TopLevelResource>
```
List projects visible to the calling user.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListProjects.FilterType

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListProjects.FilterType`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ListProjects(CurrentUser currentUser, ProjectCache projectCache, GroupsCollection groupsCollection, GroupControl.Factory groupControlFactory, GitRepositoryManager repoManager, ProjectNode.Factory projectNodeFactory, WebLinks webLinks)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addShowBranch(java.lang.String branch)`
`java.util.SortedMap<java.lang.String,com.google.gerrit.extensions.common.ProjectInfo>`	`apply()`
`java.lang.Object`	`apply(com.google.gerrit.extensions.restapi.TopLevelResource resource)`
`java.util.SortedMap<java.lang.String,com.google.gerrit.extensions.common.ProjectInfo>`	`display(java.io.OutputStream displayOutputStream)`
`OutputFormat`	`getFormat()`
`java.util.List<java.lang.String>`	`getShowBranch()`
`boolean`	`isShowDescription()`
`boolean`	`isShowTree()`
`void`	`setAll(boolean all)`
`void`	`setFilterType(ListProjects.FilterType type)`
`ListProjects`	`setFormat(OutputFormat fmt)`
`void`	`setGroupUuid(com.google.gerrit.reviewdb.client.AccountGroup.UUID groupUuid)`
`void`	`setLimit(int limit)`
`void`	`setMatchPrefix(java.lang.String matchPrefix)`
`void`	`setMatchRegex(java.lang.String matchRegex)`
`void`	`setMatchSubstring(java.lang.String matchSubstring)`
`void`	`setShowDescription(boolean showDescription)`
`void`	`setShowTree(boolean showTree)`
`void`	`setStart(int start)`

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

Constructor Detail

ListProjects

@Inject
protected ListProjects(CurrentUser currentUser,
                   ProjectCache projectCache,
                   GroupsCollection groupsCollection,
                   GroupControl.Factory groupControlFactory,
                   GitRepositoryManager repoManager,
                   ProjectNode.Factory projectNodeFactory,
                   WebLinks webLinks)

Method Detail

addShowBranch

public void addShowBranch(java.lang.String branch)

setShowTree

public void setShowTree(boolean showTree)

setFilterType

public void setFilterType(ListProjects.FilterType type)

setShowDescription

public void setShowDescription(boolean showDescription)

setAll
```
public void setAll(boolean all)
```

setLimit
```
public void setLimit(int limit)
```

setStart
```
public void setStart(int start)
```

setMatchPrefix

public void setMatchPrefix(java.lang.String matchPrefix)

setMatchSubstring

public void setMatchSubstring(java.lang.String matchSubstring)

setMatchRegex

public void setMatchRegex(java.lang.String matchRegex)

setGroupUuid

public void setGroupUuid(com.google.gerrit.reviewdb.client.AccountGroup.UUID groupUuid)

getShowBranch

public java.util.List<java.lang.String> getShowBranch()

isShowTree
```
public boolean isShowTree()
```

isShowDescription
```
public boolean isShowDescription()
```

getFormat
```
public OutputFormat getFormat()
```

setFormat

public ListProjects setFormat(OutputFormat fmt)

apply
```
public java.lang.Object apply(com.google.gerrit.extensions.restapi.TopLevelResource resource)
                       throws com.google.gerrit.extensions.restapi.BadRequestException
```
Specified by:

apply in interface com.google.gerrit.extensions.restapi.RestReadView<com.google.gerrit.extensions.restapi.TopLevelResource>

Throws:

com.google.gerrit.extensions.restapi.BadRequestException

apply

public java.util.SortedMap<java.lang.String,com.google.gerrit.extensions.common.ProjectInfo> apply()
                                                                                            throws com.google.gerrit.extensions.restapi.BadRequestException

Throws:: com.google.gerrit.extensions.restapi.BadRequestException

display

public java.util.SortedMap<java.lang.String,com.google.gerrit.extensions.common.ProjectInfo> display(java.io.OutputStream displayOutputStream)
                                                                                              throws com.google.gerrit.extensions.restapi.BadRequestException

Throws:: com.google.gerrit.extensions.restapi.BadRequestException

Class ListProjects

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListProjects

Method Detail

addShowBranch

setShowTree

setFilterType

setShowDescription

setAll

setLimit

setStart

setMatchPrefix

setMatchSubstring

setMatchRegex

setGroupUuid

getShowBranch

isShowTree

isShowDescription

getFormat

setFormat

apply

apply

display