ChangeIndexer (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.index.ChangeIndexer

```
public class ChangeIndexer
extends Object
```
Helper for (re)indexing a change document.
Indexing is run in the background, as it may require substantial work to compute some of the fields and/or update the index.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ChangeIndexer.Factory

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`delete(ChangeData cd)` Synchronously delete a change.
`void`	`delete(com.google.gerrit.reviewdb.server.ReviewDb db, com.google.gerrit.reviewdb.client.Change change)` Synchronously delete a change.
`com.google.common.util.concurrent.CheckedFuture<?,IOException>`	`deleteAsync(com.google.gerrit.reviewdb.client.Change.Id id)` Start deleting a change.
`void`	`index(ChangeData cd)` Synchronously index a change.
`void`	`index(com.google.gerrit.reviewdb.server.ReviewDb db, com.google.gerrit.reviewdb.client.Change change)` Synchronously index a change.
`com.google.common.util.concurrent.CheckedFuture<?,IOException>`	`indexAsync(com.google.gerrit.reviewdb.client.Change.Id id)` Start indexing a change.

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

Method Detail

indexAsync

public com.google.common.util.concurrent.CheckedFuture<?,IOException> indexAsync(com.google.gerrit.reviewdb.client.Change.Id id)

Start indexing a change.

Parameters:: id - change to index.
Returns:: future for the indexing task.

index
```
public void index(ChangeData cd)
           throws IOException
```
Synchronously index a change.

Parameters:
cd - change to index.

Throws:

IOException

index

public void index(com.google.gerrit.reviewdb.server.ReviewDb db,
         com.google.gerrit.reviewdb.client.Change change)
           throws IOException

Synchronously index a change.

Parameters:: change - change to index.; db - review database.
Throws:: IOException

deleteAsync

public com.google.common.util.concurrent.CheckedFuture<?,IOException> deleteAsync(com.google.gerrit.reviewdb.client.Change.Id id)

Start deleting a change.

Parameters:: id - change to delete.
Returns:: future for the deleting task.

delete
```
public void delete(ChangeData cd)
            throws IOException
```
Synchronously delete a change.

Parameters:
cd - change to delete.

Throws:

IOException

delete

public void delete(com.google.gerrit.reviewdb.server.ReviewDb db,
          com.google.gerrit.reviewdb.client.Change change)
            throws IOException

Synchronously delete a change.

Parameters:: change - change to delete.; db - review database.
Throws:: IOException

Class ChangeIndexer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

indexAsync

index

index

deleteAsync

delete

delete