Class ChangeEditApi.NotImplemented
java.lang.Object
com.google.gerrit.extensions.api.changes.ChangeEditApi.NotImplemented
- All Implemented Interfaces:
ChangeEditApi
- Enclosing interface:
- ChangeEditApi
A default implementation which allows source compatibility when adding new methods to the
interface.
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.google.gerrit.extensions.api.changes.ChangeEditApi
ChangeEditApi.ChangeEditDetailRequest, ChangeEditApi.NotImplemented
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
create()
Creates a new change edit.void
delete()
Deletes the change edit.void
deleteFile
(String filePath) Deletes the specified file from the change edit.detail()
get()
Retrieves details regarding the change edit.Retrieves the commit message of the change edit.Retrieves the contents of the specified file from the change edit.void
modifyCommitMessage
(String newCommitMessage) Modifies the commit message of the change edit.void
modifyFile
(String filePath, FileContentInput input) Modify the contents of the specified file of the change edit.void
publish()
Publishes the change edit using default settings.void
publish
(PublishChangeEditInput publishChangeEditInput) Publishes the change edit.void
rebase()
Rebases the change edit on top of the latest patch set of this change.void
renameFile
(String oldFilePath, String newFilePath) Renames a file of the change edit or moves the file to another directory.void
restoreFile
(String filePath) Restores a file of the change edit to the state in which it was before the patch set on which the change edit is based.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.google.gerrit.extensions.api.changes.ChangeEditApi
modifyFile
-
Constructor Details
-
NotImplemented
public NotImplemented()
-
-
Method Details
-
detail
- Specified by:
detail
in interfaceChangeEditApi
- Throws:
RestApiException
-
get
Description copied from interface:ChangeEditApi
Retrieves details regarding the change edit.- Specified by:
get
in interfaceChangeEditApi
- Returns:
- an
Optional
containing details about the change edit if it exists, orOptional.empty()
- Throws:
RestApiException
- if the change edit couldn't be retrieved
-
create
Description copied from interface:ChangeEditApi
Creates a new change edit. It has exactly the same Git tree as the current patch set of the change.- Specified by:
create
in interfaceChangeEditApi
- Throws:
RestApiException
- if the change edit couldn't be created or a change edit already exists
-
delete
Description copied from interface:ChangeEditApi
Deletes the change edit.- Specified by:
delete
in interfaceChangeEditApi
- Throws:
RestApiException
- if the change edit couldn't be deleted or a change edit wasn't present
-
rebase
Description copied from interface:ChangeEditApi
Rebases the change edit on top of the latest patch set of this change.- Specified by:
rebase
in interfaceChangeEditApi
- Throws:
RestApiException
- if the change edit couldn't be rebased or a change edit wasn't present
-
publish
Description copied from interface:ChangeEditApi
Publishes the change edit using default settings. SeeChangeEditApi.publish(PublishChangeEditInput)
for more details.- Specified by:
publish
in interfaceChangeEditApi
- Throws:
RestApiException
- if the change edit couldn't be published or a change edit wasn't present
-
publish
Description copied from interface:ChangeEditApi
Publishes the change edit. Publishing means that the change edit is turned into a regular patch set of the change.- Specified by:
publish
in interfaceChangeEditApi
- Parameters:
publishChangeEditInput
- aPublishChangeEditInput
specifying the options which should be applied- Throws:
RestApiException
- if the change edit couldn't be published or a change edit wasn't present
-
getFile
Description copied from interface:ChangeEditApi
Retrieves the contents of the specified file from the change edit.- Specified by:
getFile
in interfaceChangeEditApi
- Parameters:
filePath
- the path of the file- Returns:
- an
Optional
containing the contents of the file as aBinaryResult
if the file exists within the change edit, orOptional.empty()
- Throws:
RestApiException
- if the contents of the file couldn't be retrieved or a change edit wasn't present
-
renameFile
Description copied from interface:ChangeEditApi
Renames a file of the change edit or moves the file to another directory. If the change edit doesn't exist, it will be created based on the current patch set of the change.- Specified by:
renameFile
in interfaceChangeEditApi
- Parameters:
oldFilePath
- the current file pathnewFilePath
- the desired file path- Throws:
RestApiException
- if the file couldn't be renamed
-
restoreFile
Description copied from interface:ChangeEditApi
Restores a file of the change edit to the state in which it was before the patch set on which the change edit is based. This includes the file content as well as the existence or non-existence of the file. If the change edit doesn't exist, it will be created based on the current patch set of the change.- Specified by:
restoreFile
in interfaceChangeEditApi
- Parameters:
filePath
- the path of the file- Throws:
RestApiException
- if the file couldn't be restored to its previous state
-
modifyFile
Description copied from interface:ChangeEditApi
Modify the contents of the specified file of the change edit. If no content is provided, the content of the file is erased but the file isn't deleted. If the change edit doesn't exist, it will be created based on the current patch set of the change.- Specified by:
modifyFile
in interfaceChangeEditApi
- Parameters:
filePath
- the path of the file which should be modifiedinput
- the desired content of the file- Throws:
RestApiException
- if the content of the file couldn't be modified
-
deleteFile
Description copied from interface:ChangeEditApi
Deletes the specified file from the change edit. If the change edit doesn't exist, it will be created based on the current patch set of the change.- Specified by:
deleteFile
in interfaceChangeEditApi
- Parameters:
filePath
- the path fo the file which should be deleted- Throws:
RestApiException
- if the file couldn't be deleted
-
getCommitMessage
Description copied from interface:ChangeEditApi
Retrieves the commit message of the change edit.- Specified by:
getCommitMessage
in interfaceChangeEditApi
- Returns:
- the commit message of the change edit
- Throws:
RestApiException
- if the commit message couldn't be retrieved or a change edit wasn't present
-
modifyCommitMessage
Description copied from interface:ChangeEditApi
Modifies the commit message of the change edit. If the change edit doesn't exist, it will be created based on the current patch set of the change.- Specified by:
modifyCommitMessage
in interfaceChangeEditApi
- Parameters:
newCommitMessage
- the desired commit message- Throws:
RestApiException
- if the commit message couldn't be modified
-