ChangeEdits (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.change.ChangeEdits

All Implemented Interfaces:

com.google.gerrit.extensions.restapi.AcceptsCreate<ChangeResource>, com.google.gerrit.extensions.restapi.AcceptsDelete<ChangeResource>, com.google.gerrit.extensions.restapi.AcceptsPost<ChangeResource>, com.google.gerrit.extensions.restapi.ChildCollection<ChangeResource,ChangeEditResource>, com.google.gerrit.extensions.restapi.RestCollection<ChangeResource,ChangeEditResource>, com.google.gerrit.extensions.restapi.RestView<ChangeResource>
```
public class ChangeEdits
extends Object
implements com.google.gerrit.extensions.restapi.ChildCollection<ChangeResource,ChangeEditResource>, com.google.gerrit.extensions.restapi.AcceptsCreate<ChangeResource>, com.google.gerrit.extensions.restapi.AcceptsPost<ChangeResource>, com.google.gerrit.extensions.restapi.AcceptsDelete<ChangeResource>
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChangeEdits.Create`
`static class`	`ChangeEdits.DeleteContent` Handler to delete a file.
`static class`	`ChangeEdits.DeleteFile`
`static class`	`ChangeEdits.Detail`
`static class`	`ChangeEdits.EditMessage`
`static class`	`ChangeEdits.Get`
`static class`	`ChangeEdits.GetMessage`
`static class`	`ChangeEdits.GetMeta`
`static class`	`ChangeEdits.Post` Post to edit collection resource.
`static class`	`ChangeEdits.Put` Put handler that is activated when PUT request is called on collection element.

Method Summary

Methods
Modifier and Type	Method and Description
`ChangeEdits.Create`	`create(ChangeResource parent, com.google.gerrit.extensions.restapi.IdString id)`
`ChangeEdits.DeleteFile`	`delete(ChangeResource parent, com.google.gerrit.extensions.restapi.IdString id)` Create handler that is activated when collection element is accessed but doesn't exist, e.
`com.google.gerrit.extensions.restapi.RestView<ChangeResource>`	`list()`
`ChangeEditResource`	`parse(ChangeResource rsrc, com.google.gerrit.extensions.restapi.IdString id)`
`ChangeEdits.Post`	`post(ChangeResource parent)`
`com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<ChangeEditResource>>`	`views()`

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

Method Detail

views

public com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<ChangeEditResource>> views()

Specified by:: views in interface com.google.gerrit.extensions.restapi.RestCollection<ChangeResource,ChangeEditResource>

list
```
public com.google.gerrit.extensions.restapi.RestView<ChangeResource> list()
```
Specified by:

list in interface com.google.gerrit.extensions.restapi.RestCollection<ChangeResource,ChangeEditResource>

parse

public ChangeEditResource parse(ChangeResource rsrc,
                       com.google.gerrit.extensions.restapi.IdString id)
                         throws com.google.gerrit.extensions.restapi.ResourceNotFoundException,
                                com.google.gerrit.extensions.restapi.AuthException,
                                IOException,
                                InvalidChangeOperationException,
                                com.google.gwtorm.server.OrmException

Specified by:: parse in interface com.google.gerrit.extensions.restapi.RestCollection<ChangeResource,ChangeEditResource>
Throws:: com.google.gerrit.extensions.restapi.ResourceNotFoundException; com.google.gerrit.extensions.restapi.AuthException; IOException; InvalidChangeOperationException; com.google.gwtorm.server.OrmException

create

public ChangeEdits.Create create(ChangeResource parent,
                        com.google.gerrit.extensions.restapi.IdString id)
                          throws com.google.gerrit.extensions.restapi.RestApiException

Specified by:: create in interface com.google.gerrit.extensions.restapi.AcceptsCreate<ChangeResource>
Throws:: com.google.gerrit.extensions.restapi.RestApiException

post
```
public ChangeEdits.Post post(ChangeResource parent)
                      throws com.google.gerrit.extensions.restapi.RestApiException
```
Specified by:

post in interface com.google.gerrit.extensions.restapi.AcceptsPost<ChangeResource>

Throws:

com.google.gerrit.extensions.restapi.RestApiException

delete
```
public ChangeEdits.DeleteFile delete(ChangeResource parent,
                            com.google.gerrit.extensions.restapi.IdString id)
                              throws com.google.gerrit.extensions.restapi.RestApiException
```
Create handler that is activated when collection element is accessed but doesn't exist, e. g. PUT request with a path was called but change edit wasn't created yet. Change edit is created and PUT handler is called.

Specified by:

delete in interface com.google.gerrit.extensions.restapi.AcceptsDelete<ChangeResource>

Throws:

com.google.gerrit.extensions.restapi.RestApiException

Class ChangeEdits

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

views

list

parse

create

post

delete